Private Endpoint Connections - List By Resource

참조

Service:: Key Vault

API Version:: 2022-07-01

목록 작업은 자격 증명 모음과 연결된 프라이빗 엔드포인트 연결에 대한 정보를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
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 버전.

응답

Name	형식	Description
200 OK	PrivateEndpointConnectionListResult	지정된 리소스 그룹의 모든 프라이빗 엔드포인트 연결에 대한 정보를 가져옵니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

예제

KeyVaultListPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections?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_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.list_by_resource(
        resource_group_name="sample-group",
        vault_name="sample-vault",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listPrivateEndpointConnection.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-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"
        }
      }
    },
    {
      "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"
        }
      }
    }
  ],
  "nextLink": null
}

정의

Name	Description
ActionsRequired	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
CloudError	Key Vault 리소스 공급자의 오류 응답
CloudErrorBody	Key Vault 리소스 공급자의 오류 응답
PrivateEndpoint	프라이빗 엔드포인트 개체 속성입니다.
PrivateEndpointConnection	프라이빗 엔드포인트 연결 리소스.
PrivateEndpointConnectionListResult	프라이빗 엔드포인트 연결 목록입니다.
PrivateEndpointConnectionProvisioningState	현재 프로비저닝 상태입니다.
PrivateEndpointServiceConnectionStatus	프라이빗 엔드포인트 연결 상태.
PrivateLinkServiceConnectionState	프라이빗 링크 연결의 승인 상태를 나타내는 개체입니다.

ActionsRequired

서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.

Name	형식	Description
None	string

CloudError

Key Vault 리소스 공급자의 오류 응답

Name	형식	Description
error	CloudErrorBody	Key Vault 리소스 공급자의 오류 응답

CloudErrorBody

Key Vault 리소스 공급자의 오류 응답

Name	형식	Description
code	string	오류 코드 프로그래밍 방식으로 사용할 수 있는 니모닉입니다.
message	string	사용자에게 친숙한 오류 메시지입니다. 메시지는 일반적으로 지역화되며 서비스 버전에 따라 다를 수 있습니다.

PrivateEndpoint

프라이빗 엔드포인트 개체 속성입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트 리소스의 전체 식별자입니다.

PrivateEndpointConnection

프라이빗 엔드포인트 연결 리소스.

Name	형식	Description
etag	string	프라이빗 엔드포인트 연결 상태가 변경되면 수정됩니다.
id	string	키 자격 증명 모음 리소스의 정규화된 식별자입니다.
location	string	키 자격 증명 모음 리소스의 Azure 위치입니다.
name	string	키 자격 증명 모음 리소스의 이름입니다.
properties.privateEndpoint	PrivateEndpoint	프라이빗 엔드포인트 개체의 속성입니다.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	프라이빗 링크 연결의 승인 상태입니다.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
tags	object	키 자격 증명 모음 리소스에 할당된 태그입니다.
type	string	키 자격 증명 모음 리소스의 리소스 유형입니다.

PrivateEndpointConnectionListResult

프라이빗 엔드포인트 연결 목록입니다.

Name	형식	Description
nextLink	string	다음 프라이빗 엔드포인트 연결 집합을 가져올 URL입니다.
value	PrivateEndpointConnection[]	프라이빗 엔드포인트 연결 목록입니다.

PrivateEndpointConnectionProvisioningState

현재 프로비저닝 상태입니다.

Name	형식	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

프라이빗 엔드포인트 연결 상태.

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

프라이빗 링크 연결의 승인 상태를 나타내는 개체입니다.

Name	형식	Description
actionsRequired	ActionsRequired	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
description	string	승인 또는 거부 이유입니다.
status	PrivateEndpointServiceConnectionStatus	키 자격 증명 모음 소유자가 연결을 승인, 거부 또는 제거했는지 여부를 나타냅니다.