MHSM Private Endpoint Connections - List By Resource

참조

Service:: Key Vault

API Version:: 2022-07-01

목록 작업은 관리형 HSM 풀과 연결된 프라이빗 엔드포인트 연결에 대한 정보를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
name	path	True	string	관리형 HSM 풀의 이름
resourceGroupName	path	True	string	관리되는 HSM 풀을 포함하는 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전.

응답

Name	형식	Description
200 OK	MHSMPrivateEndpointConnectionsListResult	지정된 구독의 모든 관리형 HSM 풀에 대한 정보를 가져옵니다.
Other Status Codes	ManagedHsmError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

List managed HSM Pools in a subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/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 managed_hsm_list_private_endpoint_connections_by_resource.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.mhsm_private_endpoint_connections.list_by_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.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/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec1",
      "name": "sample-pec1",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe1"
        },
        "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/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec2",
      "name": "sample-pec2",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe2"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    }
  ],
  "nextLink": null
}

정의

Name	Description
ActionsRequired	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
Error	서버 오류입니다.
identityType	키 자격 증명 모음 리소스를 만든 ID 유형입니다.
ManagedHsmError	오류 예외입니다.
ManagedHsmSku	SKU 세부 정보
ManagedHsmSkuFamily	관리되는 HSM 풀의 SKU 제품군
ManagedHsmSkuName	관리형 HSM 풀의 SKU
MHSMPrivateEndpoint	프라이빗 엔드포인트 개체 속성입니다.
MHSMPrivateEndpointConnection	프라이빗 엔드포인트 연결 리소스.
MHSMPrivateEndpointConnectionsListResult	관리형 HSM 풀과 연결된 프라이빗 엔드포인트 연결 목록
MHSMPrivateLinkServiceConnectionState	프라이빗 링크 연결의 승인 상태를 나타내는 개체입니다.
PrivateEndpointConnectionProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
PrivateEndpointServiceConnectionStatus	키 자격 증명 모음 소유자가 연결을 승인, 거부 또는 제거했는지 여부를 나타냅니다.
SystemData	키 자격 증명 모음 리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

ActionsRequired

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

Name	형식	Description
None	string

Error

서버 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
innererror	Error	내부 오류에는 보다 구체적인 오류 코드가 포함되어 있습니다.
message	string	오류 메시지입니다.

identityType

키 자격 증명 모음 리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

오류 예외입니다.

Name	형식	Description
error	Error	서버 오류입니다.

ManagedHsmSku

SKU 세부 정보

Name	형식	Description
family	ManagedHsmSkuFamily	관리되는 HSM 풀의 SKU 제품군
name	ManagedHsmSkuName	관리형 HSM 풀의 SKU

ManagedHsmSkuFamily

관리되는 HSM 풀의 SKU 제품군

Name	형식	Description
B	string

ManagedHsmSkuName

관리형 HSM 풀의 SKU

Name	형식	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateEndpoint

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

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

MHSMPrivateEndpointConnection

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

Name	형식	Description
etag	string	프라이빗 엔드포인트 연결 상태가 변경될 때마다 수정됩니다.
id	string	관리되는 HSM 풀에 대한 Azure Resource Manager 리소스 ID입니다.
location	string	관리되는 HSM 풀을 만들어야 하는 지원되는 Azure 위치입니다.
name	string	관리되는 HSM 풀의 이름입니다.
properties.privateEndpoint	MHSMPrivateEndpoint	프라이빗 엔드포인트 개체의 속성입니다.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	프라이빗 링크 연결의 승인 상태입니다.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
sku	ManagedHsmSku	SKU 세부 정보
systemData	SystemData	키 자격 증명 모음 리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
tags	object	리소스 태그
type	string	관리되는 HSM 풀의 리소스 종류입니다.

MHSMPrivateEndpointConnectionsListResult

관리형 HSM 풀과 연결된 프라이빗 엔드포인트 연결 목록

Name	형식	Description
nextLink	string	관리되는 HSM 풀의 다음 집합을 가져올 URL입니다.
value	MHSMPrivateEndpointConnection[]	관리형 HSM 풀과 연결된 프라이빗 엔드포인트 연결입니다.

MHSMPrivateLinkServiceConnectionState

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

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

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

SystemData

키 자격 증명 모음 리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	키 자격 증명 모음 리소스 만들기(UTC)의 타임스탬프입니다.
createdBy	string	키 자격 증명 모음 리소스를 만든 ID입니다.
createdByType	identityType	키 자격 증명 모음 리소스를 만든 ID 유형입니다.
lastModifiedAt	string	키 자격 증명 모음 리소스 마지막 수정(UTC)의 타임스탬프입니다.
lastModifiedBy	string	키 자격 증명 모음 리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	identityType	키 자격 증명 모음 리소스를 마지막으로 수정한 ID 유형입니다.