Dela via

Iot Hub Resource - Check Name Availability

Tjänst:
IoT Hub
API-version:
2023-06-30

Kontrollera om ett IoT-hubbnamn är tillgängligt.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

URI-parametrar

Name I Obligatorisk Typ Description
subscriptionId
 path True

string

Prenumerationsidentifieraren.
api-version
 query True

string

Versionen av API:et.

Begärandetext

Name Obligatorisk Typ Description
name True

string

Namnet på den IoT-hubb som ska kontrolleras.

Svar

Name Typ Description
200 OK

IotHubNameAvailabilityInfo

Det här är en synkron åtgärd. Brödtexten innehåller ett JSON-serialiserat svar som anger om IoT Hub-namnet är tillgängligt. Om namnet inte är tillgängligt innehåller brödtexten orsaken.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

IotHubResource_CheckNameAvailability

Exempelbegäran

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

{
  "name": "test-request"
}

Exempelsvar

Statuskod:
200 
{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": ""
}

Definitioner

Name Description
ErrorDetails

Felinformation.
IotHubNameAvailabilityInfo

Egenskaperna som anger om ett angivet IoT-hubbnamn är tillgängligt.
IotHubNameUnavailabilityReason

Orsaken till otillgänglighet.
OperationInputs

Indatavärden.

ErrorDetails

Objekt

Felinformation.

Name Typ Description
code

string

Felkoden.
details

string

Felinformationen.
httpStatusCode

string

HTTP-statuskoden.
message

string

Felmeddelandet.

IotHubNameAvailabilityInfo

Objekt

Egenskaperna som anger om ett angivet IoT-hubbnamn är tillgängligt.

Name Typ Description
message

string

Det detaljerade orsaksmeddelandet.
nameAvailable

boolean

Värdet som anger om det angivna namnet är tillgängligt.
reason

IotHubNameUnavailabilityReason

Orsaken till otillgänglighet.

IotHubNameUnavailabilityReason

Uppräkning

Orsaken till otillgänglighet.

Värde Description
Invalid
AlreadyExists

OperationInputs

Objekt

Indatavärden.

Name Typ Description
name

string

Namnet på den IoT-hubb som ska kontrolleras.