Private Link Resources - List By Vault

Service:

Key Vault

API Version:

2021-10-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateLinkResources?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	PrivateLinkResourceListResult	Успешно извлечены ресурсы приватного канала.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Примеры

KeyVaultListPrivateLinkResources

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateLinkResources?api-version=2021-10-01

Go

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/listPrivateLinkResources.json
func ExamplePrivateLinkResourcesClient_ListByVault() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkeyvault.NewPrivateLinkResourcesClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListByVault(ctx,
		"sample-group",
		"sample-vault",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

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-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateLinkResources/vault",
      "name": "vault",
      "type": "Microsoft.KeyVault/vaults/privateLinkResources",
      "properties": {
        "groupId": "vault",
        "requiredMembers": [
          "default"
        ],
        "requiredZoneNames": [
          "privatelink.vaultcore.azure.net"
        ]
      }
    }
  ]
}

Определения

CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
PrivateLinkResource	Ресурс приватного канала
PrivateLinkResourceListResult	Список ресурсов приватного канала

CloudError

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

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

CloudErrorBody

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

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

PrivateLinkResource

Ресурс приватного канала

Name	Type	Description
id	string	Полный идентификатор ресурса хранилища ключей.
location	string	Расположение ресурса хранилища ключей в Azure.
name	string	Имя ресурса хранилища ключей.
properties.groupId	string	Идентификатор группы ресурса приватного канала.
properties.requiredMembers	string[]	Обязательные имена членов ресурса приватного канала.
properties.requiredZoneNames	string[]	Обязательные имена зон DNS ресурса приватного канала.
tags	object	Теги, назначенные ресурсу хранилища ключей.
type	string	Тип ресурса хранилища ключей.

PrivateLinkResourceListResult

Список ресурсов приватного канала

Name	Type	Description
value	PrivateLinkResource[]	Массив ресурсов приватного канала