Private Link Resources - List By Vault

Service:

Key Vault

API Version:

2021-10-01

Gets the private link resources supported for the key vault.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Name of the resource group that contains the key vault.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vaultName	path	True	string	The name of the key vault. Regex pattern: ^[a-zA-Z0-9-]{3,24}$
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	PrivateLinkResourceListResult	Successfully retrieved private link resources.
Other Status Codes	CloudError	Error response describing why the operation failed.

Examples

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

Definitions

CloudError	An error response from Key Vault resource provider
CloudErrorBody	An error response from Key Vault resource provider
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources

CloudError

An error response from Key Vault resource provider

Name	Type	Description
error	CloudErrorBody	An error response from Key Vault resource provider

CloudErrorBody

An error response from Key Vault resource provider

Name	Type	Description
code	string	Error code. This is a mnemonic that can be consumed programmatically.
message	string	User friendly error message. The message is typically localized and may vary with service version.

PrivateLinkResource

A private link resource

Name	Type	Description
id	string	Fully qualified identifier of the key vault resource.
location	string	Azure location of the key vault resource.
name	string	Name of the key vault resource.
properties.groupId	string	Group identifier of private link resource.
properties.requiredMembers	string[]	Required member names of private link resource.
properties.requiredZoneNames	string[]	Required DNS zone names of the the private link resource.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

PrivateLinkResourceListResult

A list of private link resources

Name	Type	Description
value	PrivateLinkResource[]	Array of private link resources