MHSM Private Endpoint Connections - List By Resource

Ссылка

Service:: Key Vault

API Version:: 2021-10-01

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

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

Параметры URI

Name	In	Required	Type	Description
name	path	True	string	Имя управляемого пула HSM
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей управляемый пул HSM.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Ответы

Name	Type	Description
200 OK	MHSMPrivateEndpointConnectionsListResult	Получение сведений обо всех управляемых пулах HSM в указанной подписке.
Other Status Codes	ManagedHsmError	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name	Description
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=2021-10-01

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2021-10-01/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json
func ExampleMHSMPrivateEndpointConnectionsClient_NewListByResourcePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkeyvault.NewMHSMPrivateEndpointConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourcePager("sample-group",
		"sample-mhsm",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 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
}

Определения

ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.
Error	Ошибка сервера.
identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
ManagedHsmError	Исключение в результате ошибки.
ManagedHsmSku	Сведения о номере SKU
ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
ManagedHsmSkuName	SKU управляемого пула HSM
MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
MHSMPrivateEndpointConnection	Ресурс подключения к частной конечной точке.
MHSMPrivateEndpointConnectionsListResult	Список подключений к частной конечной точке, связанных с управляемыми пулами HSM
MHSMPrivateLinkServiceConnectionState	Объект, представляющий состояние утверждения подключения приватного канала.
PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса хранилища ключей.

ActionsRequired

Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.

Name	Type	Description
None	string

Error

Ошибка сервера.

Name	Type	Description
code	string	Код ошибки.
innererror	Error	Внутренняя ошибка содержит более конкретный код ошибки.
message	string	Сообщение об ошибке.

identityType

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

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

Исключение в результате ошибки.

Name	Type	Description
error	Error	Ошибка сервера.

ManagedHsmSku

Сведения о номере SKU

Name	Type	Description
family	ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
name	ManagedHsmSkuName	SKU управляемого пула HSM

ManagedHsmSkuFamily

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

Name	Type	Description
B	string

ManagedHsmSkuName

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

Name	Type	Description
Custom_B32	string
Standard_B1	string

MHSMPrivateEndpoint

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

Name	Type	Description
id	string	Полный идентификатор ресурса частной конечной точки.

MHSMPrivateEndpointConnection

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

Name	Type	Description
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

Name	Type	Description
nextLink	string	URL-адрес для получения следующего набора управляемых пулов HSM.
value	MHSMPrivateEndpointConnection[]	Подключение к частной конечной точке, связанное с управляемыми пулами HSM.

MHSMPrivateLinkServiceConnectionState

Объект, представляющий состояние утверждения подключения приватного канала.

Name	Type	Description
actionsRequired	ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения.
status	PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.

PrivateEndpointConnectionProvisioningState

Состояние подготовки подключения к частной конечной точке.

Name	Type	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SystemData

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

Name	Type	Description
createdAt	string	Метка времени создания ресурса хранилища ключей (UTC).
createdBy	string	Удостоверение, создающее ресурс хранилища ключей.
createdByType	identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
lastModifiedAt	string	Метка времени последнего изменения ресурса хранилища ключей (UTC).
lastModifiedBy	string	Удостоверение, которое в последний раз изменило ресурс хранилища ключей.
lastModifiedByType	identityType	Тип удостоверения, который последний раз изменил ресурс хранилища ключей.