Iot Dps Resource - Check Provisioning Service Name Availability

Szolgáltatás:

IoT Hub Device Provisioning Service

API-verzió:

2022-12-12

Ellenőrizze, hogy elérhető-e a kiépítési szolgáltatás neve. Ez ellenőrzi, hogy a név szintaktikailag érvényes-e, és hogy a név használható-e

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	Az ellenőrizni kívánt kiépítési szolgáltatás neve.

Válaszok

Name	Típus	Description
200 OK	NameAvailabilityInfo	Ez egy szinkron művelet. A törzs egy JSON-szerializált választ tartalmaz, amely meghatározza, hogy elérhető-e a kiépítési szolgáltatás neve. Ha a név nem érhető el, a törzs tartalmazza az okot.
Other Status Codes	ErrorDetails	Alapértelmezett hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

DPSCheckName

Mintakérelem

HTTP

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

{
  "name": "test213123"
}

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
ErrorDetails	Hiba részletei.
NameAvailabilityInfo	A név rendelkezésre állásának leírása.
NameUnavailabilityReason	megadja, hogy egy név miért nem érhető el
OperationInputs	Bemeneti értékek a műveleti eredmények hívásához.

ErrorDetails

Hiba részletei.

Name	Típus	Description
code	integer	A hibakód.
details	string	A hiba részletei.
httpStatusCode	string	A HTTP-állapotkód.
message	string	A hibaüzenet.

NameAvailabilityInfo

A név rendelkezésre állásának leírása.

Name	Típus	Description
message	string	a részletes oknevet tartalmazó üzenet nem érhető el
nameAvailable	boolean	megadja, hogy egy név elérhető-e vagy sem
reason	NameUnavailabilityReason	megadja, hogy egy név miért nem érhető el

NameUnavailabilityReason

megadja, hogy egy név miért nem érhető el

Name	Típus	Description
AlreadyExists	string
Invalid	string

OperationInputs

Bemeneti értékek a műveleti eredmények hívásához.

Name	Típus	Description
name	string	Az ellenőrizni kívánt kiépítési szolgáltatás neve.