Iot Dps Resource - Check Provisioning Service Name Availability

Référence

Service:: IoT Hub Device Provisioning Service

Version d'API:: 2022-12-12

Vérifiez si un nom de service d’approvisionnement est disponible. Cela permet de vérifier si le nom est syntaxiquement valide et si le nom est utilisable.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l’API.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom du service d’approvisionnement à case activée.

Réponses

Nom	Type	Description
200 OK	NameAvailabilityInfo	Il s’agit d’une opération synchrone. Le corps contient une réponse sérialisée JSON qui spécifie si le nom du service d’approvisionnement est disponible. Si le nom n’est pas disponible, le corps contient la raison.
Other Status Codes	ErrorDetails	Réponse d’erreur par défaut.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

DPSCheckName

Exemple de requête

HTTP

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

{
  "name": "test213123"
}

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
ErrorDetails	Détails de l’erreur.
NameAvailabilityInfo	Description de la disponibilité des noms.
NameUnavailabilityReason	spécifie la raison pour laquelle un nom n’est pas disponible
OperationInputs	Valeurs d’entrée pour l’appel des résultats de l’opération.

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	integer	Code d'erreur.
details	string	Détails de l’erreur.
httpStatusCode	string	Code d’état HTTP.
message	string	Message d’erreur.

NameAvailabilityInfo

Description de la disponibilité des noms.

Nom	Type	Description
message	string	message contenant un nom de motif détaillé non disponible
nameAvailable	boolean	spécifie si un nom est disponible ou non
reason	NameUnavailabilityReason	spécifie la raison pour laquelle un nom n’est pas disponible

NameUnavailabilityReason

spécifie la raison pour laquelle un nom n’est pas disponible

Nom	Type	Description
AlreadyExists	string
Invalid	string

OperationInputs

Valeurs d’entrée pour l’appel des résultats de l’opération.

Nom	Type	Description
name	string	Nom du service d’approvisionnement à case activée.

Partager via