Vaults - Check Name Availability

Service:

Key Vault

API Version:

2022-07-01

Checks that the vault name is valid and is not already in use.

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

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
name	True	string	The vault name.
type	True	Type	The type of resource, Microsoft.KeyVault/vaults

Responses

Name	Type	Description
200 OK	CheckNameAvailabilityResult	OK -- Operation to check the vault name availability was successful.
Other Status Codes	CloudError	Error response describing why the operation failed.

Examples

Validate a vault name

Sample Request

HTTP

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"
}

Python

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
}

Definitions

Name	Description
CheckNameAvailabilityResult	The CheckNameAvailability operation response.
CloudError	An error response from Key Vault resource provider
CloudErrorBody	An error response from Key Vault resource provider
Reason	The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
Type	The type of resource, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	The parameters used to check the availability of the vault name.

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

Name	Type	Description
message	string	An error message explaining the Reason value in more detail.
nameAvailable	boolean	A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
reason	Reason	The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.

CloudError

An error response from Key Vault resource provider

Name	Type	Description
error	CloudErrorBody	An error response from Key Vault resource provider

CloudErrorBody

An error response from Key Vault resource provider

Name	Type	Description
code	string	Error code. This is a mnemonic that can be consumed programmatically.
message	string	User friendly error message. The message is typically localized and may vary with service version.

Reason

The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.

Name	Type	Description
AccountNameInvalid	string
AlreadyExists	string

Type

The type of resource, Microsoft.KeyVault/vaults

Name	Type	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

The parameters used to check the availability of the vault name.

Name	Type	Description
name	string	The vault name.
type	Type	The type of resource, Microsoft.KeyVault/vaults