Partilhar via


Iot Hub Resource - Check Name Availability

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

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

Parâmetros do URI

Name Em Necessário Tipo Description
subscriptionId
path True

string

O identificador da subscrição.

api-version
query True

string

A versão da API.

Corpo do Pedido

Name Necessário Tipo Description
name True

string

O nome do hub IoT a verificar.

Respostas

Name Tipo Description
200 OK

IotHubNameAvailabilityInfo

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

Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

IotHubResource_CheckNameAvailability

Pedido de amostra

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

{
  "name": "test-request"
}

Resposta da amostra

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

Definições

Name Description
ErrorDetails

Detalhes do erro.

IotHubNameAvailabilityInfo

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

IotHubNameUnavailabilityReason

O motivo da indisponibilidade.

OperationInputs

Valores de entrada.

ErrorDetails

Detalhes do erro.

Name Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de estado HTTP.

message

string

A mensagem de erro.

IotHubNameAvailabilityInfo

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

Name 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.

Name Tipo Description
AlreadyExists

string

Invalid

string

OperationInputs

Valores de entrada.

Name Tipo Description
name

string

O nome do hub IoT a verificar.