Vaults - Check Name Availability

Service:

Key Vault

API Version:

2022-07-01

Sprawdza, czy nazwa magazynu jest prawidłowa i nie jest jeszcze używana.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa magazynu.
type	True	Type	Typ zasobu, Microsoft.KeyVault/vaults

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CheckNameAvailabilityResult	OK — operacja sprawdzania dostępności nazwy magazynu zakończyła się pomyślnie.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

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
}

Definicje

Nazwa	Opis
CheckNameAvailabilityResult	Odpowiedź operacji CheckNameAvailability.
CloudError	Odpowiedź na błąd dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault
Reason	Przyczyna, dla którego nie można użyć nazwy magazynu. Element Reason jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.
Type	Typ zasobu, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Parametry używane do sprawdzania dostępności nazwy magazynu.

CheckNameAvailabilityResult

Odpowiedź operacji CheckNameAvailability.

Nazwa	Typ	Opis
message	string	Komunikat o błędzie wyjaśniający wartość Przyczyna bardziej szczegółowo.
nameAvailable	boolean	Wartość logiczna wskazująca, czy nazwa jest dostępna do użycia. Jeśli wartość true, nazwa jest dostępna. Jeśli wartość false, nazwa została już podjęta lub jest nieprawidłowa i nie można jej użyć.
reason	Reason	Przyczyna, dla którego nie można użyć nazwy magazynu. Element Reason jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.

CloudError

Odpowiedź na błąd dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault

CloudErrorBody

Odpowiedź na błąd dostawcy zasobów Key Vault

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonic, który może być używany programowo.
message	string	Przyjazny dla użytkownika komunikat o błędzie. Komunikat jest zazwyczaj zlokalizowany i może się różnić w zależności od wersji usługi.

Reason

Przyczyna, dla którego nie można użyć nazwy magazynu. Element Reason jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.

Nazwa	Typ	Opis
AccountNameInvalid	string
AlreadyExists	string

Type

Typ zasobu, Microsoft.KeyVault/vaults

Nazwa	Typ	Opis
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Parametry używane do sprawdzania dostępności nazwy magazynu.

Nazwa	Typ	Opis
name	string	Nazwa magazynu.
type	Type	Typ zasobu, Microsoft.KeyVault/vaults