你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	确定 -- 检查保管库名称可用性的操作已成功。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

示例

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
}

定义

名称	说明
CheckNameAvailabilityResult	CheckNameAvailability 操作响应。
CloudError	密钥保管库资源提供程序的错误响应
CloudErrorBody	密钥保管库资源提供程序的错误响应
Reason	无法使用保管库名称的原因。 仅当 NameAvailable 为 false 时，才会返回 Reason 元素。
Type	资源类型，Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	用于检查保管库名称的可用性的参数。

CheckNameAvailabilityResult

CheckNameAvailability 操作响应。

名称	类型	说明
message	string	更详细地解释了 Reason 值的错误消息。
nameAvailable	boolean	一个布尔值，指示名称是否可供你使用。 如果为 true，则名称可用。 如果为 false，则表示该名称已被采用或无效且无法使用。
reason	Reason	无法使用保管库名称的原因。 仅当 NameAvailable 为 false 时，才会返回 Reason 元素。

CloudError

密钥保管库资源提供程序的错误响应

名称	类型	说明
error	CloudErrorBody	密钥保管库资源提供程序的错误响应

CloudErrorBody

密钥保管库资源提供程序的错误响应

名称	类型	说明
code	string	错误代码。 这是可以编程方式使用的助记键。
message	string	用户友好的错误消息。 消息通常是本地化的，可能因服务版本而异。

Reason

无法使用保管库名称的原因。 仅当 NameAvailable 为 false 时，才会返回 Reason 元素。

名称	类型	说明
AccountNameInvalid	string
AlreadyExists	string

Type

资源类型，Microsoft.KeyVault/vaults

名称	类型	说明
Microsoft.KeyVault/vaults	string

VaultCheckNameAvailabilityParameters

用于检查保管库名称的可用性的参数。

名称	类型	说明
name	string	保管库名称。
type	Type	资源类型，Microsoft.KeyVault/vaults