Private Endpoint Connections - List By Resource

Ссылка

Service:: Key Vault

API Version:: 2021-10-01

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

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

Параметры URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей хранилище ключей.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.
vaultName	path	True	string	Имя хранилища ключей. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Версия API клиента.

Ответы

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

Примеры

KeyVaultListPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/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/listPrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_NewListByResourcePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkeyvault.NewPrivateEndpointConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourcePager("sample-group",
		"sample-vault",
		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/vaults/sample-vault/privateEndpointConnections/sample-pec",
      "name": "sample-pec",
      "type": "Microsoft.KeyVault/vaults/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"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
      "name": "sample-pec",
      "type": "Microsoft.KeyVault/vaults/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"
        }
      }
    }
  ],
  "nextLink": null
}

Определения

ActionsRequired	Сообщение о том, требуются ли изменения в поставщике услуг.
CloudError	Ответ об ошибке поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке поставщика ресурсов Key Vault
PrivateEndpoint	Свойства объекта частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionListResult	Список подключений к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Объект, представляющий состояние утверждения подключения приватного канала.

ActionsRequired

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

Name	Type	Description
None	string

CloudError

Ответ об ошибке поставщика ресурсов Key Vault

Name	Type	Description
error	CloudErrorBody	Ответ об ошибке поставщика ресурсов Key Vault

CloudErrorBody

Ответ об ошибке поставщика ресурсов Key Vault

Name	Type	Description
code	string	Код ошибки. Это mnemonic, который можно использовать программным способом.
message	string	Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться в зависимости от версии службы.

PrivateEndpoint

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

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

PrivateEndpointConnection

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

Name	Type	Description
etag	string	Изменяется при изменении состояния подключения к частной конечной точке.
id	string	Полный идентификатор ресурса хранилища ключей.
location	string	Расположение ресурса хранилища ключей в Azure.
name	string	Имя ресурса хранилища ключей.
properties.privateEndpoint	PrivateEndpoint	Свойства объекта частной конечной точки.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Состояние утверждения подключения приватного канала.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
tags	object	Теги, назначенные ресурсу хранилища ключей.
type	string	Тип ресурса хранилища ключей.

PrivateEndpointConnectionListResult

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

Name	Type	Description
nextLink	string	URL-адрес для получения следующего набора подключений к частной конечной точке.
value	PrivateEndpointConnection[]	Список подключений к частной конечной точке.

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

PrivateLinkServiceConnectionState

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

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