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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含金鑰保存庫的資源群組名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
vaultName	path	True	string	金鑰保存庫的名稱。 Regex pattern: ^[a-zA-Z0-9-]{3,24}$
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	PrivateLinkResourceListResult	已成功擷取私人鏈接資源。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

範例

KeyVaultListPrivateLinkResources

Sample Request

HTTP

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

Python

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"
        ]
      }
    }
  ]
}

定義

名稱	Description
CloudError	金鑰保存庫 資源提供者的錯誤回應
CloudErrorBody	金鑰保存庫 資源提供者的錯誤回應
PrivateLinkResource	私人鏈接資源
PrivateLinkResourceListResult	私人鏈接資源清單

CloudError

金鑰保存庫 資源提供者的錯誤回應

名稱	類型	Description
error	CloudErrorBody	金鑰保存庫 資源提供者的錯誤回應

CloudErrorBody

金鑰保存庫 資源提供者的錯誤回應

名稱	類型	Description
code	string	錯誤碼。 這是可透過程序設計方式取用的助記鍵。
message	string	使用者易記的錯誤訊息。 訊息通常是本地化的，而且可能會隨著服務版本而有所不同。

PrivateLinkResource

私人鏈接資源

名稱	類型	Description
id	string	金鑰保存庫資源的完整識別碼。
location	string	金鑰保存庫資源的 Azure 位置。
name	string	金鑰保存庫資源的名稱。
properties.groupId	string	私人鏈接資源的群組標識碼。
properties.requiredMembers	string[]	私人鏈接資源的必要成員名稱。
properties.requiredZoneNames	string[]	私人鏈接資源的必要 DNS 區域名稱。
tags	object	指派給金鑰保存庫資源的標記。
type	string	金鑰保存庫資源的資源類型。

PrivateLinkResourceListResult

私人鏈接資源清單

名稱	類型	Description
value	PrivateLinkResource[]	私人鏈接資源的陣列