Iot Dps Resource - Check Provisioning Service Name Availability

Reference

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Zkontrolujte, jestli je k dispozici název služby zřizování. Tím se ověří, jestli je název syntakticky platný a jestli je použitelný.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string	Název služby zřizování, která se má zkontrolovat.

Odpovědi

Name	Typ	Description
200 OK	NameAvailabilityInfo	Jedná se o synchronní operaci. Tělo obsahuje odpověď serializovanou ve formátu JSON, která určuje, jestli je k dispozici název služby zřizování. Pokud název není k dispozici, text obsahuje důvod.
Other Status Codes	ErrorDetails	Výchozí chybová odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

DPSCheckName

Sample Request

HTTP

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

{
  "name": "test213123"
}

Sample Response

Status code:: 200

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

Definice

Name	Description
ErrorDetails	Podrobnosti o chybě.
NameAvailabilityInfo	Popis dostupnosti názvu.
NameUnavailabilityReason	určuje důvod, proč je název nedostupný.
OperationInputs	Vstupní hodnoty pro volání výsledků operace.

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	integer	Kód chyby
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP
message	string	Chybová zpráva

NameAvailabilityInfo

Popis dostupnosti názvu.

Name	Typ	Description
message	string	Zpráva obsahující podrobný název důvodu není k dispozici
nameAvailable	boolean	určuje, jestli je název dostupný, nebo ne.
reason	NameUnavailabilityReason	určuje důvod, proč je název nedostupný.

NameUnavailabilityReason

určuje důvod, proč je název nedostupný.

Name	Typ	Description
AlreadyExists	string
Invalid	string

OperationInputs

Vstupní hodnoty pro volání výsledků operace.

Name	Typ	Description
name	string	Název služby zřizování, která se má zkontrolovat.