Vaults - Check Name Availability

Referencia

Service:: Key Vault

API Version:: 2022-07-01

Comprueba que el nombre del almacén es válido y que aún no está en uso.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre del almacén.
type	True	Type	Tipo de recurso, Microsoft.KeyVault/vaults

Respuestas

Nombre	Tipo	Description
200 OK	CheckNameAvailabilityResult	Correcto: operación para comprobar que la disponibilidad del nombre del almacén se realizó correctamente.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Ejemplos

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
}

Definiciones

Nombre	Description
CheckNameAvailabilityResult	Respuesta de la operación CheckNameAvailability.
CloudError	Respuesta de error del proveedor de recursos de Key Vault
CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault
Reason	Motivo por el que no se pudo usar un nombre de almacén. El elemento Reason solo se devuelve si NameAvailable es false.
Type	Tipo de recurso, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Parámetros usados para comprobar la disponibilidad del nombre del almacén.

CheckNameAvailabilityResult

Respuesta de la operación CheckNameAvailability.

Nombre	Tipo	Description
message	string	Mensaje de error que explica el valor reason con más detalle.
nameAvailable	boolean	Valor booleano que indica si el nombre está disponible para su uso. Si es true, el nombre está disponible. Si es false, el nombre ya se ha tomado o no es válido y no se puede usar.
reason	Reason	Motivo por el que no se pudo usar un nombre de almacén. El elemento Reason solo se devuelve si NameAvailable es false.

CloudError

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
code	string	Código de error. Se trata de una mnemónica que se puede consumir mediante programación.
message	string	Mensaje de error descriptivo. El mensaje suele localizarse y puede variar con la versión del servicio.

Reason

Motivo por el que no se pudo usar un nombre de almacén. El elemento Reason solo se devuelve si NameAvailable es false.

Nombre	Tipo	Description
AccountNameInvalid	string
AlreadyExists	string

Type

Tipo de recurso, Microsoft.KeyVault/vaults

Nombre	Tipo	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Parámetros usados para comprobar la disponibilidad del nombre del almacén.

Nombre	Tipo	Description
name	string	Nombre del almacén.
type	Type	Tipo de recurso, Microsoft.KeyVault/vaults