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

MHSM Private Endpoint Connections - List By Resource

List 操作获取与托管 HSM 池关联的专用终结点连接的相关信息。

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

URI 参数

名称 必需 类型 说明
name
path True

string

托管 HSM 池的名称

resourceGroupName
path True

string

包含托管 HSM 池的资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

MHSMPrivateEndpointConnectionsListResult

获取有关指定订阅中所有托管 HSM 池的信息。

Other Status Codes

ManagedHsmError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
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

示例响应

{
  "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
}

定义

名称 说明
ActionsRequired

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

Error

服务器错误。

identityType

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

ManagedHsmError

错误异常。

ManagedHsmSku

SKU 详细信息

ManagedHsmSkuFamily

托管 HSM 池的 SKU 系列

ManagedHsmSkuName

托管 HSM 池的 SKU

MHSMPrivateEndpoint

专用终结点对象属性。

MHSMPrivateEndpointConnection

专用终结点连接资源。

MHSMPrivateEndpointConnectionsListResult

与托管 HSM 池关联的专用终结点连接列表

MHSMPrivateLinkServiceConnectionState

一个 对象,表示专用链接连接的审批状态。

PrivateEndpointConnectionProvisioningState

专用终结点连接的预配状态。

PrivateEndpointServiceConnectionStatus

指示连接是否已由密钥保管库所有者批准、拒绝或删除。

SystemData

与密钥保管库资源的创建和上次修改相关的元数据。

ActionsRequired

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

名称 类型 说明
None

string

Error

服务器错误。

名称 类型 说明
code

string

错误代码。

innererror

Error

内部错误包含更具体的错误代码。

message

string

错误消息。

identityType

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

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ManagedHsmError

错误异常。

名称 类型 说明
error

Error

服务器错误。

ManagedHsmSku

SKU 详细信息

名称 类型 说明
family

ManagedHsmSkuFamily

托管 HSM 池的 SKU 系列

name

ManagedHsmSkuName

托管 HSM 池的 SKU

ManagedHsmSkuFamily

托管 HSM 池的 SKU 系列

名称 类型 说明
B

string

ManagedHsmSkuName

托管 HSM 池的 SKU

名称 类型 说明
Custom_B32

string

Custom_B6

string

Standard_B1

string

MHSMPrivateEndpoint

专用终结点对象属性。

名称 类型 说明
id

string

专用终结点资源的完整标识符。

MHSMPrivateEndpointConnection

专用终结点连接资源。

名称 类型 说明
etag

string

每当专用终结点连接的状态发生更改时修改。

id

string

托管 HSM 池的 Azure 资源管理器资源 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 池关联的专用终结点连接列表

名称 类型 说明
nextLink

string

用于获取下一组托管 HSM 池的 URL。

value

MHSMPrivateEndpointConnection[]

与托管 HSM 池关联的专用终结点连接。

MHSMPrivateLinkServiceConnectionState

一个 对象,表示专用链接连接的审批状态。

名称 类型 说明
actionsRequired

ActionsRequired

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

description

string

批准或拒绝的原因。

status

PrivateEndpointServiceConnectionStatus

指示连接是否已由密钥保管库所有者批准、拒绝或删除。

PrivateEndpointConnectionProvisioningState

专用终结点连接的预配状态。

名称 类型 说明
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

指示连接是否已由密钥保管库所有者批准、拒绝或删除。

名称 类型 说明
Approved

string

Disconnected

string

Pending

string

Rejected

string

SystemData

与密钥保管库资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

密钥保管库资源创建的时间戳 (UTC) 。

createdBy

string

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

createdByType

identityType

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

lastModifiedAt

string

上次修改密钥保管库资源的时间戳 (UTC) 。

lastModifiedBy

string

上次修改密钥保管库资源的标识。

lastModifiedByType

identityType

上次修改密钥保管库资源的标识类型。