你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

MHSM Private Endpoint Connections - Get

参考

服务:: Key Vault

API 版本:: 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 参数

名称	在	必需	类型	说明
name	path	True	string	托管 HSM 池的名称
privateEndpointConnectionName	path	True	string	与托管 hsm 池关联的专用终结点连接的名称。
resourceGroupName	path	True	string	包含托管 HSM 池的资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	MHSMPrivateEndpointConnection	已成功返回专用终结点连接。
Other Status Codes	ManagedHsmError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ManagedHsmGetPrivateEndpointConnection

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

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

示例响应

状态代码:: 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"
    }
  }
}

定义

名称	说明
ActionsRequired	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
Error	服务器错误。
identityType	创建密钥保管库资源的标识类型。
ManagedHsmError	错误异常。
ManagedHsmSku	SKU 详细信息
ManagedHsmSkuFamily	托管 HSM 池的 SKU 系列
ManagedHsmSkuName	托管 HSM 池的 SKU
MHSMPrivateEndpoint	专用终结点对象属性。
MHSMPrivateEndpointConnection	专用终结点连接资源。
MHSMPrivateLinkServiceConnectionState	一个表示专用链接连接的审批状态的对象。
PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。
PrivateEndpointServiceConnectionStatus	指示密钥保管库所有者是否已批准、拒绝或删除连接。
SystemData	与密钥保管库资源的创建和上次修改相关的元数据。

ActionsRequired

枚举

一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。

值	说明
None

Error

Object

服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	内部错误包含更具体的错误代码。
message	string	错误消息。

identityType

枚举

创建密钥保管库资源的标识类型。

值	说明
Application
Key
ManagedIdentity
User

ManagedHsmError

Object

错误异常。

名称	类型	说明
error	Error	服务器错误。

ManagedHsmSku

Object

SKU 详细信息

名称	类型	说明
family	ManagedHsmSkuFamily	托管 HSM 池的 SKU 系列
name	ManagedHsmSkuName	托管 HSM 池的 SKU

ManagedHsmSkuFamily

枚举

托管 HSM 池的 SKU 系列

值	说明
B

ManagedHsmSkuName

枚举

托管 HSM 池的 SKU

值	说明
Custom_B32
Custom_B6
Standard_B1