Udostępnij za pośrednictwem


Iot Hub Resource - Check Name Availability

Sprawdź, czy nazwa centrum IoT jest dostępna.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
subscriptionId
path True

string

Identyfikator subskrypcji.

api-version
query True

string

Wersja interfejsu API.

Treść żądania

Nazwa Wymagane Typ Opis
name True

string

Nazwa centrum IoT do sprawdzenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

IotHubNameAvailabilityInfo

Jest to operacja synchroniczna. Treść zawiera odpowiedź serializowaną w formacie JSON, która określa, czy nazwa centrum IoT jest dostępna. Jeśli nazwa jest niedostępna, treść zawiera przyczynę.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

IotHubResource_CheckNameAvailability

Przykładowe żądanie

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

{
  "name": "test-request"
}

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ErrorDetails

Szczegóły błędu.

IotHubNameAvailabilityInfo

Właściwości wskazujące, czy dana nazwa centrum IoT jest dostępna.

IotHubNameUnavailabilityReason

Przyczyna niedostępności.

OperationInputs

Wartości wejściowe.

ErrorDetails

Szczegóły błędu.

Nazwa Typ Opis
code

string

Kod błędu.

details

string

Szczegóły błędu.

httpStatusCode

string

Kod stanu HTTP.

message

string

Komunikat o błędzie.

IotHubNameAvailabilityInfo

Właściwości wskazujące, czy dana nazwa centrum IoT jest dostępna.

Nazwa Typ Opis
message

string

Szczegółowy komunikat przyczyny.

nameAvailable

boolean

Wartość wskazująca, czy podana nazwa jest dostępna.

reason

IotHubNameUnavailabilityReason

Przyczyna niedostępności.

IotHubNameUnavailabilityReason

Przyczyna niedostępności.

Nazwa Typ Opis
AlreadyExists

string

Invalid

string

OperationInputs

Wartości wejściowe.

Nazwa Typ Opis
name

string

Nazwa centrum IoT do sprawdzenia.