Vaults - Check Name Availability

Referenz

Service:: Key Vault

API Version:: 2022-07-01

Überprüft, ob der Tresorname gültig ist und noch nicht verwendet wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der Tresorname.
type	True	Type	Der Ressourcentyp Microsoft.KeyVault/vaults

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityResult	OK – Vorgang zum Überprüfen der Verfügbarkeit des Tresornamens war erfolgreich.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

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
}

Definitionen

Name	Beschreibung
CheckNameAvailabilityResult	Die Antwort des CheckNameAvailability-Vorgangs.
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
Reason	Der Grund dafür, dass ein Tresorname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable den Wert false aufweist.
Type	Der Ressourcentyp Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Die Parameter, die zum Überprüfen der Verfügbarkeit des Tresornamens verwendet werden.

CheckNameAvailabilityResult

Die Antwort des CheckNameAvailability-Vorgangs.

Name	Typ	Beschreibung
message	string	Eine Fehlermeldung, in der der Reason-Wert ausführlicher erläutert wird.
nameAvailable	boolean	Ein boolescher Wert, der angibt, ob der Name für Sie verfügbar ist. Wenn true, ist der Name verfügbar. Wenn false, wurde der Name bereits übernommen oder ist ungültig und kann nicht verwendet werden.
reason	Reason	Der Grund dafür, dass ein Tresorname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable den Wert false aufweist.

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

Reason

Der Grund dafür, dass ein Tresorname nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable den Wert false aufweist.

Name	Typ	Beschreibung
AccountNameInvalid	string
AlreadyExists	string

Type

Der Ressourcentyp Microsoft.KeyVault/vaults

Name	Typ	Beschreibung
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Die Parameter, die zum Überprüfen der Verfügbarkeit des Tresornamens verwendet werden.

Name	Typ	Beschreibung
name	string	Der Tresorname.
type	Type	Der Ressourcentyp Microsoft.KeyVault/vaults

Share via