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

Private Link Resources - List By Vault

参考

Service:: Key Vault

API Version:: 2022-07-01

获取密钥保管库支持的专用链接资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateLinkResources?api-version=2022-07-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	包含 Key Vault 的资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
vaultName	path	True	string	密钥保管库的名称。 Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	PrivateLinkResourceListResult	已成功检索专用链接资源。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

示例

KeyVaultListPrivateLinkResources

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateLinkResources?api-version=2022-07-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_private_link_resources.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.private_link_resources.list_by_vault(
        resource_group_name="sample-group",
        vault_name="sample-vault",
    )
    print(response)


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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateLinkResources/vault",
      "name": "vault",
      "type": "Microsoft.KeyVault/vaults/privateLinkResources",
      "properties": {
        "groupId": "vault",
        "requiredMembers": [
          "default"
        ],
        "requiredZoneNames": [
          "privatelink.vaultcore.azure.net"
        ]
      }
    }
  ]
}

定义

名称	说明
CloudError	密钥保管库资源提供程序的错误响应
CloudErrorBody	密钥保管库资源提供程序的错误响应
PrivateLinkResource	专用链接资源
PrivateLinkResourceListResult	专用链接资源列表

CloudError

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

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

CloudErrorBody

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

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

PrivateLinkResource

专用链接资源

名称	类型	说明
id	string	密钥保管库资源的完全限定标识符。
location	string	密钥保管库资源的 Azure 位置。
name	string	密钥保管库资源的名称。
properties.groupId	string	专用链接资源的组标识符。
properties.requiredMembers	string[]	专用链接资源的必需成员名称。
properties.requiredZoneNames	string[]	专用链接资源的所需 DNS 区域名称。
tags	object	分配给密钥保管库资源的标记。
type	string	密钥保管库资源的资源类型。

PrivateLinkResourceListResult

专用链接资源列表

名称	类型	说明
value	PrivateLinkResource[]	专用链接资源的数组