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á a ser utilizado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome do cofre.
type	True	Type	O tipo de recurso, Microsoft.KeyVault/vaults

Respostas

Name	Tipo	Description
200 OK	CheckNameAvailabilityResult	OK - Operação para verificar se a disponibilidade do nome do cofre foi efetuada com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual 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

Name	Description
CheckNameAvailabilityResult	A resposta da operação CheckNameAvailability.
CloudError	Uma resposta de erro do fornecedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault
Reason	O motivo pelo qual não foi possível utilizar um nome de cofre. O elemento Motivo só é devolvido se Nome Disponível for falso.
Type	O tipo de recurso, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Os parâmetros utilizados para verificar a disponibilidade do nome do cofre.

CheckNameAvailabilityResult

A resposta da operação CheckNameAvailability.

Name	Tipo	Description
message	string	Uma mensagem de erro a explicar o valor motivo mais detalhadamente.
nameAvailable	boolean	Um valor booleano que indica se o nome está disponível para utilização. Se for verdadeiro, o nome está disponível. Se for falso, o nome já foi utilizado ou é inválido e não pode ser utilizado.
reason	Reason	O motivo pelo qual não foi possível utilizar um nome de cofre. O elemento Motivo só é devolvido se Nome Disponível for falso.

CloudError

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
code	string	Código de erro. Este é um mnemónico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável do utilizador. Normalmente, a mensagem é localizada e pode variar consoante a versão do serviço.

Reason

O motivo pelo qual não foi possível utilizar um nome de cofre. O elemento Motivo só é devolvido se Nome Disponível for falso.

Name	Tipo	Description
AccountNameInvalid	string
AlreadyExists	string

Type

O tipo de recurso, Microsoft.KeyVault/vaults

Name	Tipo	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Os parâmetros utilizados para verificar a disponibilidade do nome do cofre.

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