Vaults - Check Name Availability

Reference

Service:: Key Vault

API Version:: 2022-07-01

Zkontroluje, jestli je název trezoru platný a že se ještě nepoužívá.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string	Název trezoru.
type	True	Type	Typ prostředku, Microsoft.KeyVault/vaults

Odpovědi

Name	Typ	Description
200 OK	CheckNameAvailabilityResult	OK – Operace pro kontrolu dostupnosti názvu trezoru proběhla úspěšně.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Příklady

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
}

Definice

Name	Description
CheckNameAvailabilityResult	Odpověď operace CheckNameAvailability
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
Reason	Důvod, proč nelze použít název trezoru. Element Reason je vrácen pouze v případě, že NameAvailable je false.
Type	Typ prostředku, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Parametry použité ke kontrole dostupnosti názvu trezoru.

CheckNameAvailabilityResult

Odpověď operace CheckNameAvailability

Name	Typ	Description
message	string	Chybová zpráva s podrobnějším vysvětlením hodnoty Reason
nameAvailable	boolean	Logická hodnota, která určuje, jestli je název k dispozici k použití. Pokud je hodnota true, název je k dispozici. Pokud je false, název již byl převzat nebo je neplatný a nelze ho použít.
reason	Reason	Důvod, proč nelze použít název trezoru. Element Reason je vrácen pouze v případě, že NameAvailable je false.

CloudError

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault

CloudErrorBody

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
code	string	Kód chyby Toto je mnemotechnická funkce, kterou je možné využívat programově.
message	string	Uživatelsky přívětivá chybová zpráva. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

Reason

Důvod, proč nelze použít název trezoru. Element Reason je vrácen pouze v případě, že NameAvailable je false.

Name	Typ	Description
AccountNameInvalid	string
AlreadyExists	string

Type

Typ prostředku, Microsoft.KeyVault/vaults

Name	Typ	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Parametry použité ke kontrole dostupnosti názvu trezoru.

Name	Typ	Description
name	string	Název trezoru.
type	Type	Typ prostředku, Microsoft.KeyVault/vaults