Iot Dps Resource - Check Provisioning Service Name Availability

Serviço:

IoT Hub Device Provisioning Service

Versão da API:

2022-12-12

Verifique se um nome de serviço de provisionamento está disponível. Isso 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 de assinatura.
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 Provisionamento a ser verificado.

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar 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 do nome.
NameUnavailabilityReason	Especifica o motivo pelo qual um nome não está disponível
OperationInputs	Valores de entrada para chamada de resultados de operação.

ErrorDetails

Object

Detalhes do erro.

Name	Tipo	Description
code	integer (int32)	O código de erro.
details	string	Os detalhes do erro.
httpStatusCode	string	O código de status HTTP.
message	string	A mensagem de erro.

NameAvailabilityInfo

Object

Descrição da disponibilidade do nome.

Name	Tipo	Description
message	string	mensagem contendo um nome de motivo detalhado não está disponível
nameAvailable	boolean	Especifica se um nome está disponível ou não
reason	NameUnavailabilityReason	Especifica o motivo pelo qual um nome não está disponível

NameUnavailabilityReason

Enumeração

Especifica o motivo pelo qual um nome não está disponível

Valor	Description
AlreadyExists
Invalid

OperationInputs

Object

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

Name	Tipo	Description
name	string	O nome do Serviço de Provisionamento a ser verificado.