Iot Dps Resource - Check Provisioning Service Name Availability

Referência

Serviço:: IoT Hub Device Provisioning Service

Versão da API:: 2022-12-12

Verifique se está disponível um nome de serviço de aprovisionamento. Isto validará se o nome é sintaticamente válido e se o nome é utilizável

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

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 Serviço de Aprovisionamento a verificar.

Respostas

Name	Tipo	Description
200 OK	NameAvailabilityInfo	Esta é uma operação síncrona. O corpo contém uma resposta serializada JSON que especifica se o nome do serviço de aprovisionamento está disponível. Se o nome não estiver disponível, o corpo contém o motivo.
Other Status Codes	ErrorDetails	Resposta de erro predefinida.

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

DPSCheckName

Pedido de amostra

HTTP

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

{
  "name": "test213123"
}

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
ErrorDetails	Detalhes do erro.
NameAvailabilityInfo	Descrição da disponibilidade de nomes.
NameUnavailabilityReason	especifica o motivo pelo qual um nome está indisponível
OperationInputs	Valores de entrada para a chamada de resultados da operação.

ErrorDetails

Detalhes do erro.

Name	Tipo	Description
code	integer	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.

NameAvailabilityInfo

Descrição da disponibilidade de nomes.

Name	Tipo	Description
message	string	mensagem que contém um motivo detalhado para o nome estar indisponível
nameAvailable	boolean	especifica se um nome está disponível ou não
reason	NameUnavailabilityReason	especifica o motivo pelo qual um nome está indisponível

NameUnavailabilityReason

especifica o motivo pelo qual um nome está indisponível

Name	Tipo	Description
AlreadyExists	string
Invalid	string

OperationInputs

Valores de entrada para a chamada de resultados da operação.

Name	Tipo	Description
name	string	O nome do Serviço de Aprovisionamento a verificar.

Partilhar via