Iot Dps Resource - Check Provisioning Service Name Availability

Usługa:

IoT Hub Device Provisioning Service

Wersja interfejsu API:

2022-12-12

Sprawdź, czy nazwa usługi aprowizacji jest dostępna. Spowoduje to sprawdzenie, czy nazwa jest prawidłowa składniowo i czy nazwa może być używana

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

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 usługi Aprowizacji, która ma być sprawdzana.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NameAvailabilityInfo	Jest to operacja synchroniczna. Treść zawiera serializowaną odpowiedź w formacie JSON, która określa, czy nazwa usługi aprowizacji jest dostępna. Jeśli nazwa jest niedostępna, treść zawiera przyczynę.
Other Status Codes	ErrorDetails	Domyślna odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu 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

DPSCheckName

Przykładowe żądanie

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

{
  "name": "test213123"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": "name is valid"
}

Definicje

Nazwa	Opis
ErrorDetails	Szczegóły błędu.
NameAvailabilityInfo	Opis dostępności nazwy.
NameUnavailabilityReason	określa przyczynę niedostępności nazwy
OperationInputs	Wartości wejściowe wywołania wyników operacji.

ErrorDetails

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
code	integer (int32)	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod stanu HTTP.
message	string	Komunikat o błędzie.

NameAvailabilityInfo

Objekt

Opis dostępności nazwy.

Nazwa	Typ	Opis
message	string	komunikat zawierający szczegółową nazwę przyczyny jest niedostępny
nameAvailable	boolean	określa, czy nazwa jest dostępna, czy nie
reason	NameUnavailabilityReason	określa przyczynę niedostępności nazwy

NameUnavailabilityReason

Wyliczanie

określa przyczynę niedostępności nazwy

Wartość	Opis
AlreadyExists
Invalid

OperationInputs

Objekt

Wartości wejściowe wywołania wyników operacji.

Nazwa	Typ	Opis
name	string	Nazwa usługi Aprowizacji, która ma być sprawdzana.