Vaults - Check Name Availability

リファレンス

Service:: Key Vault

API Version:: 2022-07-01

コンテナー名が有効で、まだ使用されていないことを確認します。

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
name	True	string	コンテナー名。
type	True	Type	リソースの種類 (Microsoft.KeyVault/vaults)

応答

名前	型	説明
200 OK	CheckNameAvailabilityResult	OK -- コンテナー名の可用性をチェックする操作が成功しました。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

例

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
}

定義

名前	説明
CheckNameAvailabilityResult	CheckNameAvailability 操作の応答。
CloudError	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
Reason	コンテナー名を使用できなかった理由。 Reason 要素は、NameAvailable が false の場合にのみ返されます。
Type	リソースの種類 (Microsoft.KeyVault/vaults)
VaultCheckNameAvailabilityParameters	コンテナー名の可用性をチェックするために使用されるパラメーター。

CheckNameAvailabilityResult

CheckNameAvailability 操作の応答。

名前	型	説明
message	string	理由の値について詳しく説明するエラーメッセージ。
nameAvailable	boolean	名前を使用できるかどうかを示すブール値。 true の場合は、名前を使用できます。 false の場合、名前は既に取得されているか、無効であり、使用できません。
reason	Reason	コンテナー名を使用できなかった理由。 Reason 要素は、NameAvailable が false の場合にのみ返されます。

CloudError

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
error	CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault

CloudErrorBody

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
code	string	エラーコード。これは、プログラムで使用できるニーモニックです。
message	string	わかりやすいエラーメッセージ。通常、メッセージはローカライズされており、サービスのバージョンによって異なる場合があります。

Reason

コンテナー名を使用できなかった理由。 Reason 要素は、NameAvailable が false の場合にのみ返されます。

名前	型	説明
AccountNameInvalid	string
AlreadyExists	string

Type

リソースの種類 (Microsoft.KeyVault/vaults)

名前	型	説明
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

コンテナー名の可用性をチェックするために使用されるパラメーター。

名前	型	説明
name	string	コンテナー名。
type	Type	リソースの種類 (Microsoft.KeyVault/vaults)