Partager via


Iot Hub Resource - Check Name Availability

Vérifiez si un nom IoT Hub est disponible.

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

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 hub IoT à case activée.

Réponses

Nom Type Description
200 OK

IotHubNameAvailabilityInfo

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 hub IoT est disponible. Si le nom n’est pas disponible, le corps contient la raison.

Other Status Codes

ErrorDetails

DefaultErrorResponse

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

IotHubResource_CheckNameAvailability

Exemple de requête

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

{
  "name": "test-request"
}

Exemple de réponse

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

Définitions

Nom Description
ErrorDetails

Détails de l’erreur.

IotHubNameAvailabilityInfo

Propriétés indiquant si un nom IoT Hub donné est disponible.

IotHubNameUnavailabilityReason

Raison de l’indisponibilité.

OperationInputs

Valeurs d’entrée.

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.

IotHubNameAvailabilityInfo

Propriétés indiquant si un nom IoT Hub donné est disponible.

Nom Type Description
message

string

Message de motif détaillé.

nameAvailable

boolean

Valeur qui indique si le nom fourni est disponible.

reason

IotHubNameUnavailabilityReason

Raison de l’indisponibilité.

IotHubNameUnavailabilityReason

Raison de l’indisponibilité.

Nom Type Description
AlreadyExists

string

Invalid

string

OperationInputs

Valeurs d’entrée.

Nom Type Description
name

string

Nom du hub IoT à case activée.