Vaults - Check Name Availability

Referência

Service:: Key Vault

API Version:: 2022-07-01

Verifica se o nome do cofre é válido e ainda não está em uso.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
name	True	string	O nome do cofre.
type	True	Type	O tipo de recurso, Microsoft.KeyVault/vaults

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityResult	OK – A operação para marcar a disponibilidade do nome do cofre foi bem-sucedida.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Exemplos

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
}

Definições

Nome	Description
CheckNameAvailabilityResult	A resposta da operação CheckNameAvailability.
CloudError	Uma resposta de erro do provedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault
Reason	O motivo pelo qual um nome de cofre não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.
Type	O tipo de recurso, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Os parâmetros usados para marcar a disponibilidade do nome do cofre.

CheckNameAvailabilityResult

A resposta da operação CheckNameAvailability.

Nome	Tipo	Description
message	string	Uma mensagem de erro explicando o valor Motivo mais detalhadamente.
nameAvailable	boolean	Um valor booliano que indica se o nome está disponível para uso. Se for true, o nome estará disponível. Se false, o nome já foi usado ou é inválido e não pode ser usado.
reason	Reason	O motivo pelo qual um nome de cofre não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.

CloudError

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
code	string	Código do erro. Este é um mnemônico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável. A mensagem normalmente é localizada e pode variar com a versão do serviço.

Reason

O motivo pelo qual um nome de cofre não pôde ser usado. O elemento Reason só será retornado se NameAvailable for false.

Nome	Tipo	Description
AccountNameInvalid	string
AlreadyExists	string

Type

O tipo de recurso, Microsoft.KeyVault/vaults

Nome	Tipo	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Os parâmetros usados para marcar a disponibilidade do nome do cofre.

Nome	Tipo	Description
name	string	O nome do cofre.
type	Type	O tipo de recurso, Microsoft.KeyVault/vaults