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

Vaults - List

参考

服务:: Key Vault

API 版本:: 2022-07-01

“列出”操作获取与订阅关联的保管库的相关信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&api-version=2015-11-01

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top={$top}&api-version=2015-11-01

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
$filter	query	True	VaultListFilterTypes	要应用于操作的筛选器。
api-version	query	True	ResourceManagerApiVersions	Azure 资源管理器 Api 版本。
$top	query		integer int32	要返回的结果数上限。

响应

名称	类型	说明
200 OK	ResourceListResult	获取有关订阅中所有密钥保管库的信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

示例

List vaults in the specified subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top=1&api-version=2015-11-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python list_vault.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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listVault.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

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault",
      "name": "sample-vault",
      "type": "Microsoft.KeyVault/vaults",
      "location": "westus",
      "tags": {}
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?%24filter=resourceType+eq+%27Microsoft.KeyVault%2fvaults%27&%24top=4&api-version=2015-11-01&%24skiptoken=eyJuZXh0UGFydGl0aW9uS2V5IjoiMSE4IVEwTTJNVGMtIiwibmV4dFJvd0tleSI6IjEhMTMyIU5rUTRSVEU1UXpJelFUWXdORGd4UmpoRlFrSXhNVGhFUXpNd01EZEROVVJmVkVkT1RDMU5TVU5TVDFOUFJsUTZNa1ZMUlZsV1FWVk1WRG95UmxaQlZVeFVVeTFUVTFKSExVcEpUVG95UkZSRlUxUTZNa1JXUVZWTVZDMVhSVk5VVlZNLSJ9"
}

定义

名称	说明
CloudError	密钥保管库资源提供程序的错误响应
CloudErrorBody	密钥保管库资源提供程序的错误响应
Resource	Key Vault 资源
ResourceListResult	保管库资源列表。
ResourceManagerApiVersions	Azure 资源管理器 Api 版本。
VaultListFilterTypes	要应用于操作的筛选器。

CloudError

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

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

CloudErrorBody

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

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

Resource

Key Vault 资源

名称	类型	说明
id	string	密钥保管库资源的完全限定标识符。
location	string	密钥保管库资源的 Azure 位置。
name	string	密钥保管库资源的名称。
tags	object	分配给密钥保管库资源的标记。
type	string	密钥保管库资源的资源类型。

ResourceListResult

保管库资源列表。

名称	类型	说明
nextLink	string	用于获取下一组保管库资源的 URL。
value	Resource[]	保管库资源列表。

ResourceManagerApiVersions

Azure 资源管理器 Api 版本。

名称	类型	说明
2015-11-01	string

VaultListFilterTypes

要应用于操作的筛选器。

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

通过