MHSM Private Endpoint Connections - Get

Service:

Key Vault

API Version:

2022-07-01

取得與受控 HSM 集區相關聯的指定私人端點連線。

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

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	受控 HSM 集區的名稱
privateEndpointConnectionName	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	MHSMPrivateEndpointConnection	已成功傳回私人端點連線。
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

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

範例

ManagedHsmGetPrivateEndpointConnection

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections/sample-pec?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_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.mhsm_private_endpoint_connections.get(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_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/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "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-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

定義

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

ActionsRequired

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

名稱	類型	Description
None	string

Error

伺服器錯誤。

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

identityType

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

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

錯誤例外狀況。

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

ManagedHsmSku

SKU 詳細資料

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

ManagedHsmSkuFamily

受控 HSM 集區的 SKU 系列

名稱	類型	Description
B	string

ManagedHsmSkuName

受控 HSM 集區的 SKU

名稱	類型	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateEndpoint

私人端點對象屬性。

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

MHSMPrivateEndpointConnection

私人端點聯機資源。

名稱	類型	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 集區的資源類型。

MHSMPrivateLinkServiceConnectionState

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

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

PrivateEndpointConnectionProvisioningState

私人端點聯機的布建狀態。

名稱	類型	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

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

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SystemData

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

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