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	キーコンテナーが含まれているリソースグループの名前。
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	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
PrivateLinkResource	プライベートリンクリソース
PrivateLinkResourceListResult	プライベートリンクリソースの一覧

CloudError

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

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

CloudErrorBody

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

名前	型	説明
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[]	プライベートリンクリソースの配列