Vaults - Check Name Availability

Service:

Key Vault

API Version:

2022-07-01

Controleert of de kluisnaam geldig is en nog niet in gebruik is.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
name	True	string	De naam van de kluis.
type	True	Type	Het type resource, Microsoft.KeyVault/kluizen

Antwoorden

Name	Type	Description
200 OK	CheckNameAvailabilityResult	OK: bewerking om te controleren of de kluisnaam beschikbaar is.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

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
}

Definities

Name	Description
CheckNameAvailabilityResult	Het antwoord van de bewerking CheckNameAvailability.
CloudError	Een foutreactie van Key Vault resourceprovider
CloudErrorBody	Een foutreactie van Key Vault resourceprovider
Reason	De reden dat een kluisnaam niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is.
Type	Het type resource, Microsoft.KeyVault/kluizen
VaultCheckNameAvailabilityParameters	De parameters die worden gebruikt om de beschikbaarheid van de kluisnaam te controleren.

CheckNameAvailabilityResult

Het antwoord van de bewerking CheckNameAvailability.

Name	Type	Description
message	string	Een foutbericht waarin de redenwaarde gedetailleerder wordt uitgelegd.
nameAvailable	boolean	Een booleaanse waarde die aangeeft of de naam beschikbaar is voor gebruik. Als waar is, is de naam beschikbaar. Als de naam onwaar is, is de naam al in gebruik of is deze ongeldig en kan deze niet worden gebruikt.
reason	Reason	De reden dat een kluisnaam niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is.

CloudError

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
error	CloudErrorBody	Een foutreactie van Key Vault resourceprovider

CloudErrorBody

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
code	string	Foutcode. Dit is een ezelsbruggetje dat programmatisch kan worden gebruikt.
message	string	Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan per serviceversie verschillen.

Reason

De reden dat een kluisnaam niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is.

Name	Type	Description
AccountNameInvalid	string
AlreadyExists	string

Type

Het type resource, Microsoft.KeyVault/kluizen

Name	Type	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

De parameters die worden gebruikt om de beschikbaarheid van de kluisnaam te controleren.

Name	Type	Description
name	string	De naam van de kluis.
type	Type	Het type resource, Microsoft.KeyVault/kluizen