Freigeben über


Iot Hub Resource - Check Name Availability

Überprüfen Sie, ob ein IoT-Hubname verfügbar ist.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
path True

string

Der Abonnementbezeichner.

api-version
query True

string

Die Version der API.

Anforderungstext

Name Erforderlich Typ Beschreibung
name True

string

Der Name des zu überprüfenden IoT-Hubs.

Antworten

Name Typ Beschreibung
200 OK

IotHubNameAvailabilityInfo

Dies ist ein synchroner Vorgang. Der Text enthält eine JSON-serialisierte Antwort, die angibt, ob der IoT-Hubname verfügbar ist. Wenn der Name nicht verfügbar ist, enthält der Textkörper den Grund.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

IotHubResource_CheckNameAvailability

Beispielanforderung

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

{
  "name": "test-request"
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorDetails

Fehlerdetails.

IotHubNameAvailabilityInfo

Die Eigenschaften, die angeben, ob ein bestimmter IoT-Hubname verfügbar ist.

IotHubNameUnavailabilityReason

Der Grund für die Nichtverfügbarkeit.

OperationInputs

Eingabewerte.

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

IotHubNameAvailabilityInfo

Die Eigenschaften, die angeben, ob ein bestimmter IoT-Hubname verfügbar ist.

Name Typ Beschreibung
message

string

Die ausführliche Begründungsmeldung.

nameAvailable

boolean

Der Wert, der angibt, ob der angegebene Name verfügbar ist.

reason

IotHubNameUnavailabilityReason

Der Grund für die Nichtverfügbarkeit.

IotHubNameUnavailabilityReason

Der Grund für die Nichtverfügbarkeit.

Wert Beschreibung
AlreadyExists
Invalid

OperationInputs

Eingabewerte.

Name Typ Beschreibung
name

string

Der Name des zu überprüfenden IoT-Hubs.