Delen via

Iot Hub Resource - Check Name Availability

Service:
IoT Hub
API-versie:
2023-06-30

Controleer of de naam van een IoT-hub beschikbaar is.

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

URI-parameters

Name In Vereist Type Description
subscriptionId
 path True

string

De abonnement-ID.
api-version
 query True

string

De versie van de API.

Aanvraagbody

Name Vereist Type Description
name True

string

De naam van de IoT-hub die moet worden gecontroleerd.

Antwoorden

Name Type Description
200 OK

IotHubNameAvailabilityInfo

Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerd antwoord dat aangeeft of de naam van de IoT-hub beschikbaar is. Als de naam niet beschikbaar is, bevat de hoofdtekst de reden.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

IotHubResource_CheckNameAvailability

Voorbeeldaanvraag

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

{
  "name": "test-request"
}

Voorbeeldrespons

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

Definities

Name Description
ErrorDetails

Foutdetails.
IotHubNameAvailabilityInfo

De eigenschappen die aangeven of een bepaalde IoT-hubnaam beschikbaar is.
IotHubNameUnavailabilityReason

De reden voor onbeschikbaarheid.
OperationInputs

Invoerwaarden.

ErrorDetails

Object

Foutdetails.

Name Type Description
code

string

De foutcode.
details

string

De foutdetails.
httpStatusCode

string

De HTTP-statuscode.
message

string

Het foutbericht.

IotHubNameAvailabilityInfo

Object

De eigenschappen die aangeven of een bepaalde IoT-hubnaam beschikbaar is.

Name Type Description
message

string

Het gedetailleerde redenbericht.
nameAvailable

boolean

De waarde die aangeeft of de opgegeven naam beschikbaar is.
reason

IotHubNameUnavailabilityReason

De reden voor onbeschikbaarheid.

IotHubNameUnavailabilityReason

Inventarisatie

De reden voor onbeschikbaarheid.

Waarde Description
Invalid
AlreadyExists

OperationInputs

Object

Invoerwaarden.

Name Type Description
name

string

De naam van de IoT-hub die moet worden gecontroleerd.