Partager via


Managed Hsms - Check Mhsm Name Availability

Vérifie que le nom hsm managé est valide et qu’il n’est pas déjà utilisé.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkMhsmNameAvailability?api-version=2022-07-01

Paramètres URI

Nom Dans Obligatoire Type Description
subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version de l’API cliente.

Corps de la demande

Nom Obligatoire Type Description
name True

string

Nom hsm managé.

Réponses

Nom Type Description
200 OK

CheckMhsmNameAvailabilityResult

OK - L’opération de case activée la disponibilité du nom mhsm a réussi.

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

Validate a managed hsm name

Exemple de requête

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/checkMhsmNameAvailability?api-version=2022-07-01

{
  "name": "sample-mhsm"
}

Exemple de réponse

{
  "nameAvailable": true
}

Définitions

Nom Description
CheckMhsmNameAvailabilityParameters

Les paramètres utilisés pour case activée la disponibilité du nom hsm managé.

CheckMhsmNameAvailabilityResult

Réponse de l’opération CheckMhsmNameAvailability.

CloudError

Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

Reason

Raison pour laquelle un nom hsm managé n’a pas pu être utilisé. L’élément reason est retourné uniquement si NameAvailable a la valeur false.

CheckMhsmNameAvailabilityParameters

Les paramètres utilisés pour case activée la disponibilité du nom hsm managé.

Nom Type Description
name

string

Nom hsm managé.

CheckMhsmNameAvailabilityResult

Réponse de l’opération CheckMhsmNameAvailability.

Nom Type Description
message

string

Message d’erreur expliquant plus en détail la valeur Reason.

nameAvailable

boolean

Valeur booléenne qui indique si le nom est disponible pour vous. Si la valeur est true, le nom est disponible. Si la valeur est false, le nom a déjà été pris ou n’est pas valide et ne peut pas être utilisé.

reason

Reason

Raison pour laquelle un nom hsm managé n’a pas pu être utilisé. L’élément reason est retourné uniquement si NameAvailable a la valeur false.

CloudError

Réponse d’erreur de Key Vault fournisseur de ressources

Nom Type Description
error

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

Nom Type Description
code

string

Code d’erreur. Il s’agit d’un mnémonique qui peut être consommé par programmation.

message

string

Message d’erreur convivial. Le message est généralement localisé et peut varier en fonction de la version du service.

Reason

Raison pour laquelle un nom hsm managé n’a pas pu être utilisé. L’élément reason est retourné uniquement si NameAvailable a la valeur false.

Nom Type Description
AccountNameInvalid

string

AlreadyExists

string