Private Endpoint Connections - Get

リファレンス

Service:: Key Vault

API Version:: 2022-07-01

キーコンテナーに関連付けられている指定されたプライベートエンドポイント接続を取得します。

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

URI パラメーター

名前	/	必須	型	説明
privateEndpointConnectionName	path	True	string	キーコンテナーに関連付けられているプライベートエンドポイント接続の名前。
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	PrivateEndpointConnection	プライベートエンドポイント接続が正常に返されました。
204 No Content		プライベートエンドポイント接続が存在しません。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

例

KeyVaultGetPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?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 get_private_endpoint_connection.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_endpoint_connections.get(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        private_endpoint_connection_name="sample-pec",
    )
    print(response)


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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
  "etag": "",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

Status code:: 204

定義

名前	説明
ActionsRequired	サービスプロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。
CloudError	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
PrivateEndpoint	プライベートエンドポイントオブジェクトのプロパティ。
PrivateEndpointConnection	プライベートエンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionState	プライベートリンク接続の承認状態を表すオブジェクト。

ActionsRequired

サービスプロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。

名前	型	説明
None	string

CloudError

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

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

CloudErrorBody

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

名前	型	説明
code	string	エラーコード。これは、プログラムで使用できるニーモニックです。
message	string	ユーザーフレンドリなエラーメッセージ。通常、メッセージはローカライズされ、サービスのバージョンによって異なる場合があります。

PrivateEndpoint

プライベートエンドポイントオブジェクトのプロパティ。

名前	型	説明
id	string	プライベートエンドポイントリソースの完全な識別子。

PrivateEndpointConnection

プライベートエンドポイント接続リソース。

名前	型	説明
etag	string	プライベートエンドポイント接続の状態が変更されるたびに変更されます。
id	string	キーコンテナーリソースの完全修飾識別子。
location	string	キーコンテナーリソースの Azure の場所。
name	string	キーコンテナーリソースの名前。
properties.privateEndpoint	PrivateEndpoint	プライベートエンドポイントオブジェクトのプロパティ。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベートリンク接続の承認状態。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
tags	object	キーコンテナーリソースに割り当てられたタグ。
type	string	キーコンテナーリソースのリソースの種類。

PrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

プライベートエンドポイント接続の状態。

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

プライベートリンク接続の承認状態を表すオブジェクト。

名前	型	説明
actionsRequired	ActionsRequired	サービスプロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	承認または却下の理由。
status	PrivateEndpointServiceConnectionStatus	キーコンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。