Vaults - Check Name Availability

Service:

Key Vault

API Version:

2022-07-01

Ellenőrzi, hogy a tárolónév érvényes-e, és még nincs-e használatban.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Client API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
name	True	string	A tároló neve.
type	True	Type	Az erőforrás típusa, Microsoft.KeyVault/vaults

Válaszok

Name	Típus	Description
200 OK	CheckNameAvailabilityResult	OK – A tárolónév rendelkezésre állásának ellenőrzésére irányuló művelet sikeres volt.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

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
}

Definíciók

Name	Description
CheckNameAvailabilityResult	A CheckNameAvailability művelet válasza.
CloudError	Hibaválasz Key Vault erőforrás-szolgáltatótól
CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól
Reason	A tárolónév nem használható. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis.
Type	Az erőforrás típusa, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	A tároló nevének rendelkezésre állásának ellenőrzéséhez használt paraméterek.

CheckNameAvailabilityResult

A CheckNameAvailability művelet válasza.

Name	Típus	Description
message	string	Hibaüzenet, amely részletesebben ismerteti az Ok értéket.
nameAvailable	boolean	Logikai érték, amely azt jelzi, hogy a név használható-e. Ha igaz, a név elérhető. Ha hamis, a név már foglalt vagy érvénytelen, és nem használható.
reason	Reason	A tárolónév nem használható. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis.

CloudError

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
error	CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól

CloudErrorBody

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
code	string	Hibakód. Ez egy mnemonikus, amely programozott módon fogyasztható.
message	string	Felhasználóbarát hibaüzenet. Az üzenet általában honosított, és a szolgáltatás verziójától függően változhat.

Reason

A tárolónév nem használható. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis.

Name	Típus	Description
AccountNameInvalid	string
AlreadyExists	string

Type

Az erőforrás típusa, Microsoft.KeyVault/vaults

Name	Típus	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

A tároló nevének rendelkezésre állásának ellenőrzéséhez használt paraméterek.

Name	Típus	Description
name	string	A tároló neve.
type	Type	Az erőforrás típusa, Microsoft.KeyVault/vaults