MHSM Private Endpoint Connections - List By Resource

服務:

Key Vault

API 版本:

2022-07-01

List 作業會取得與受控 HSM 集區相關聯之私人端點聯機的相關信息。

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

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	受控 HSM 集區的名稱
resourceGroupName	path	True	string	包含受控 HSM 集區的資源群組名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	MHSMPrivateEndpointConnectionsListResult	取得指定訂用帳戶中所有受控 HSM 集區的相關信息。
Other Status Codes	ManagedHsmError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List managed HSM Pools in a subscription

範例要求

HTTP

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

Python

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

範例回覆

狀態碼:

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
}

定義

名稱	Description
ActionsRequired	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
Error	伺服器錯誤。
identityType	建立金鑰保存庫資源的身分識別類型。
ManagedHsmError	錯誤例外狀況。
ManagedHsmSku	SKU 詳細數據
ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
ManagedHsmSkuName	受控 HSM 集區的 SKU
MHSMPrivateEndpoint	私人端點對象屬性。
MHSMPrivateEndpointConnection	私人端點聯機資源。
MHSMPrivateEndpointConnectionsListResult	與受控 HSM 集區相關聯的私人端點連線清單
MHSMPrivateLinkServiceConnectionState	物件，表示私人連結連接的核准狀態。
PrivateEndpointConnectionProvisioningState	布建私人端點連線的狀態。
PrivateEndpointServiceConnectionStatus	指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。
SystemData	與金鑰保存庫資源建立和上次修改相關的元數據。

ActionsRequired

列舉型別

訊息，指出服務提供者上的變更是否需要取用者的任何更新。

值	Description
None

Error

Object

伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	內部錯誤，包含更具體的錯誤碼。
message	string	錯誤訊息。

identityType

列舉型別

建立金鑰保存庫資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

ManagedHsmError

Object

錯誤例外狀況。

名稱	類型	Description
error	Error	伺服器錯誤。

ManagedHsmSku

Object

SKU 詳細數據

名稱	類型	Description
family	ManagedHsmSkuFamily	受控 HSM 集區的 SKU 系列
name	ManagedHsmSkuName	受控 HSM 集區的 SKU

ManagedHsmSkuFamily

列舉型別

受控 HSM 集區的 SKU 系列

值	Description
B

ManagedHsmSkuName

列舉型別

受控 HSM 集區的 SKU

值	Description
Custom_B32
Custom_B6
Standard_B1

MHSMPrivateEndpoint

Object

私人端點對象屬性。

名稱	類型	Description
id	string	私人端點資源的完整標識碼。

MHSMPrivateEndpointConnection

Object

私人端點聯機資源。

名稱	類型	Description
etag	string	每當私人端點連線的狀態有所變更時，就會進行修改。
id	string	受控 HSM 集區的 Azure Resource Manager 資源識別碼。
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

Object

與受控 HSM 集區相關聯的私人端點連線清單

名稱	類型	Description
nextLink	string	要取得下一組受控 HSM 集區的 URL。
value	MHSMPrivateEndpointConnection[]	與受控 HSM 集區相關聯的私人端點連線。

MHSMPrivateLinkServiceConnectionState

Object

物件，表示私人連結連接的核准狀態。

名稱	類型	Description
actionsRequired	ActionsRequired	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准或拒絕的原因。
status	PrivateEndpointServiceConnectionStatus	指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。

PrivateEndpointConnectionProvisioningState

列舉型別

布建私人端點連線的狀態。

值	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

列舉型別

指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。

值	Description
Approved
Disconnected
Pending
Rejected

SystemData

Object

與金鑰保存庫資源建立和上次修改相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	金鑰保存庫資源建立的時間戳（UTC）。
createdBy	string	建立金鑰保存庫資源的身分識別。
createdByType	identityType	建立金鑰保存庫資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改金鑰保存庫資源的時間戳（UTC）。
lastModifiedBy	string	上次修改金鑰保存庫資源的身分識別。
lastModifiedByType	identityType	上次修改金鑰保存庫資源的身分識別類型。