Vaults - Check Name Availability

Référence

Service:: Key Vault

API Version:: 2022-07-01

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

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability?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 du coffre.
type	True	Type	Type de ressource, Microsoft.KeyVault/vaults

Réponses

Nom	Type	Description
200 OK	CheckNameAvailabilityResult	OK - L’opération de case activée la disponibilité du nom du coffre a réussi.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Validate a vault name

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

{
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults"
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python check_vault_name_availability.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.vaults.check_name_availability(
        vault_name={"name": "sample-vault", "type": "Microsoft.KeyVault/vaults"},
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/checkVaultNameAvailability.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "nameAvailable": true
}

Définitions

Nom	Description
CheckNameAvailabilityResult	Réponse de l’opération CheckNameAvailability.
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 de coffre n’a pas pu être utilisé. L’élément Reason est retourné uniquement si NameAvailable a la valeur false.
Type	Type de ressource, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Les paramètres utilisés pour case activée la disponibilité du nom du coffre.

CheckNameAvailabilityResult

Réponse de l’opération CheckNameAvailability.

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 de coffre 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 de coffre 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

Type

Type de ressource, Microsoft.KeyVault/vaults

Nom	Type	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

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

Nom	Type	Description
name	string	Nom du coffre.
type	Type	Type de ressource, Microsoft.KeyVault/vaults

Share via