Compartilhar via


Iot Dps Resource - Check Provisioning Service Name Availability

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 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 Serviço de Provisionamento a ser marcar.

Respostas

Nome 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 conterá o motivo.

Other Status Codes

ErrorDetails

Resposta de erro padrão.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

DPSCheckName

Sample Request

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

{
  "name": "test213123"
}

Sample Response

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

Definições

Nome 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 a chamada de resultados da operação.

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

integer

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.

NameAvailabilityInfo

Descrição da disponibilidade do nome.

Nome Tipo Description
message

string

mensagem que contém 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

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

Nome Tipo Description
AlreadyExists

string

Invalid

string

OperationInputs

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

Nome Tipo Description
name

string

O nome do Serviço de Provisionamento a ser marcar.