Sdílet prostřednictvím


Iot Hub Resource - Check Name Availability

Zkontrolujte, jestli je k dispozici název centra IoT.

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

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 centra IoT, který chcete zkontrolovat.

Odpovědi

Name Typ Description
200 OK

IotHubNameAvailabilityInfo

Jedná se o synchronní operaci. Tělo obsahuje odpověď serializovanou ve formátu JSON, která určuje, jestli je k dispozici název centra IoT. Pokud název není k dispozici, text obsahuje důvod.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

IotHubResource_CheckNameAvailability

Ukázkový požadavek

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

{
  "name": "test-request"
}

Ukázková odpověď

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

Definice

Name Description
ErrorDetails

Podrobnosti o chybě.

IotHubNameAvailabilityInfo

Vlastnosti označující, jestli je daný název centra IoT k dispozici.

IotHubNameUnavailabilityReason

Důvod nedostupnosti.

OperationInputs

Vstupní hodnoty.

ErrorDetails

Podrobnosti o chybě.

Name Typ Description
code

string

Kód chyby

details

string

Podrobnosti o chybě.

httpStatusCode

string

Stavový kód HTTP

message

string

Chybová zpráva

IotHubNameAvailabilityInfo

Vlastnosti označující, jestli je daný název centra IoT k dispozici.

Name Typ Description
message

string

Podrobná zpráva o důvodu.

nameAvailable

boolean

Hodnota, která označuje, zda je zadaný název k dispozici.

reason

IotHubNameUnavailabilityReason

Důvod nedostupnosti.

IotHubNameUnavailabilityReason

Důvod nedostupnosti.

Name Typ Description
AlreadyExists

string

Invalid

string

OperationInputs

Vstupní hodnoty.

Name Typ Description
name

string

Název centra IoT, který chcete zkontrolovat.