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. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True

string

Версия API клиента.

Ответы

Имя Тип Описание
200 OK

MHSMPrivateEndpointConnectionsListResult

Получение сведений обо всех управляемых пулах HSM в указанной подписке.

Other Status Codes

ManagedHsmError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

List managed HSM Pools in a subscription

Sample Request

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

Sample Response

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

Семейство SKU управляемого пула HSM

ManagedHsmSkuName

SKU управляемого пула HSM

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

Семейство SKU управляемого пула HSM

name

ManagedHsmSkuName

SKU управляемого пула HSM

ManagedHsmSkuFamily

Семейство SKU управляемого пула HSM

Имя Тип Описание
B

string

ManagedHsmSkuName

SKU управляемого пула HSM

Имя Тип Описание
Custom_B32

string

Custom_B6

string

Standard_B1

string

MHSMPrivateEndpoint

Свойства объекта частной конечной точки.

Имя Тип Описание
id

string

Полный идентификатор ресурса частной конечной точки.

MHSMPrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Имя Тип Описание
etag

string

Изменение при изменении состояния подключения к частной конечной точке.

id

string

Идентификатор ресурса azure Resource Manager для управляемого пула HSM.

location

string

Поддерживаемая служба Azure, в которой должен быть создан управляемый пул HSM.

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

URL-адрес для получения следующего набора управляемых пулов HSM.

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

Тип удостоверения, который в последний раз изменял ресурс хранилища ключей.