Vaults - Check Name Availability

Başvuru

Service:: Key Vault

API Version:: 2022-07-01

Kasa adının geçerli olduğunu ve kullanımda olmadığını denetler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci Api Sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
name	True	string	Kasa adı.
type	True	Type	Kaynak türü, Microsoft.KeyVault/vaults

Yanıtlar

Name	Tür	Description
200 OK	CheckNameAvailabilityResult	Tamam -- Kasa adı kullanılabilirliğini denetleme işlemi başarılı oldu.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

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
}

Tanımlar

Name	Description
CheckNameAvailabilityResult	CheckNameAvailability işlemi yanıtı.
CloudError	Key Vault kaynak sağlayıcısından hata yanıtı
CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı
Reason	Kasa adının kullanılamama nedeni. Reason öğesi yalnızca NameAvailable false olduğunda döndürülür.
Type	Kaynak türü, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Kasa adının kullanılabilirliğini denetlemek için kullanılan parametreler.

CheckNameAvailabilityResult

CheckNameAvailability işlemi yanıtı.

Name	Tür	Description
message	string	Neden değerini daha ayrıntılı açıklayan bir hata iletisi.
nameAvailable	boolean	Adın kullanabileceğiniz bir ad olup olmadığını gösteren boole değeri. True ise ad kullanılabilir. False ise, ad zaten alınmış veya geçersizdir ve kullanılamaz.
reason	Reason	Kasa adının kullanılamama nedeni. Reason öğesi yalnızca NameAvailable false olduğunda döndürülür.

CloudError

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
error	CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı

CloudErrorBody

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
code	string	Hata kodu. Bu, program aracılığıyla kullanılabilecek bir anımsatıcıdır.
message	string	Kullanıcı dostu hata iletisi. İleti genellikle yerelleştirilir ve hizmet sürümüne göre farklılık gösterebilir.

Reason

Kasa adının kullanılamama nedeni. Reason öğesi yalnızca NameAvailable false olduğunda döndürülür.

Name	Tür	Description
AccountNameInvalid	string
AlreadyExists	string

Type

Kaynak türü, Microsoft.KeyVault/vaults

Name	Tür	Description
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

Kasa adının kullanılabilirliğini denetlemek için kullanılan parametreler.

Name	Tür	Description
name	string	Kasa adı.
type	Type	Kaynak türü, Microsoft.KeyVault/vaults

Aracılığıyla paylaş