Compartilhar via


Iot Hub Resource - Check Name Availability

Verifique se um nome de hub IoT está disponível.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
subscriptionId
path True

string

O identificador da assinatura.

api-version
query True

string

A versão da API.

Corpo da solicitação

Nome Obrigatório Tipo Description
name True

string

O nome do hub IoT a ser marcar.

Respostas

Nome Tipo Description
200 OK

IotHubNameAvailabilityInfo

Essa é uma operação síncrona. O corpo contém uma resposta serializada em JSON que especifica se o nome do hub IoT está disponível. Se o nome não estiver disponível, o corpo conterá o motivo.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

IotHubResource_CheckNameAvailability

Solicitação de exemplo

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

{
  "name": "test-request"
}

Resposta de exemplo

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

Definições

Nome Description
ErrorDetails

Detalhes do erro.

IotHubNameAvailabilityInfo

As propriedades que indicam se um determinado nome de hub IoT está disponível.

IotHubNameUnavailabilityReason

O motivo da indisponibilidade.

OperationInputs

Valores de entrada.

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de status do HTTP.

message

string

A mensagem de erro.

IotHubNameAvailabilityInfo

As propriedades que indicam se um determinado nome de hub IoT está disponível.

Nome Tipo Description
message

string

A mensagem de motivo detalhada.

nameAvailable

boolean

O valor que indica se o nome fornecido está disponível.

reason

IotHubNameUnavailabilityReason

O motivo da indisponibilidade.

IotHubNameUnavailabilityReason

O motivo da indisponibilidade.

Nome Tipo Description
AlreadyExists

string

Invalid

string

OperationInputs

Valores de entrada.

Nome Tipo Description
name

string

O nome do hub IoT a ser marcar.