Registries - List Private Link Resources

Dienst:

Container Registry

API-Version:

2023-01-01-preview

Listet die Ressourcen für private Verknüpfungen für eine Containerregistrierung auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources?api-version=2023-01-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Der Name der Containerregistrierung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateLinkResourceListResult	Die Anforderung war erfolgreich; die Ressourcen für private Verknüpfungen wurden abgerufen und erfolgreich zurückgegeben.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RegistryListPrivateLinkResources

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources?api-version=2023-01-01-preview

Go

package armcontainerregistry_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerregistry/armcontainerregistry"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListPrivateLinkResources.json
func ExampleRegistriesClient_NewListPrivateLinkResourcesPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerregistry.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRegistriesClient().NewListPrivateLinkResourcesPager("myResourceGroup", "myRegistry", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkResourceListResult = armcontainerregistry.PrivateLinkResourceListResult{
		// 	Value: []*armcontainerregistry.PrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("registry"),
		// 			Type: to.Ptr("Microsoft.ContainerRegistry/registries/privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources/registry"),
		// 			Properties: &armcontainerregistry.PrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("registry"),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("registry"),
		// 					to.Ptr("registry_data_myregion")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.azurecr.io")},
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ContainerRegistryManagementClient } = require("@azure/arm-containerregistry");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the private link resources for a container registry.
 *
 * @summary Lists the private link resources for a container registry.
 * x-ms-original-file: specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListPrivateLinkResources.json
 */
async function registryListPrivateLinkResources() {
  const subscriptionId =
    process.env["CONTAINERREGISTRY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONTAINERREGISTRY_RESOURCE_GROUP"] || "myResourceGroup";
  const registryName = "myRegistry";
  const credential = new DefaultAzureCredential();
  const client = new ContainerRegistryManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.registries.listPrivateLinkResources(
    resourceGroupName,
    registryName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources/registry",
      "name": "registry",
      "type": "Microsoft.ContainerRegistry/registries/privateLinkResources",
      "properties": {
        "groupId": "registry",
        "requiredMembers": [
          "registry",
          "registry_data_myregion"
        ],
        "requiredZoneNames": [
          "privatelink.azurecr.io"
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
PrivateLinkResource	Eine Ressource, die private Verknüpfungsfunktionen unterstützt.
PrivateLinkResourceListResult	Das Ergebnis einer Anforderung zum Auflisten privater Linkressourcen für eine Containerregistrierung.

PrivateLinkResource

Objekt

Eine Ressource, die private Verknüpfungsfunktionen unterstützt.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID.
name	string	Der Name der Ressource.
properties.groupId	string	Die GRUPPEN-ID der privaten Verknüpfungsressource.
properties.requiredMembers	string[]	Die Namen der privaten Verknüpfungsressource, die Membernamen erforderlich sind.
properties.requiredZoneNames	string[]	Der Name der privaten Verknüpfungsressource für private Verknüpfungs-DNS-Zonen.
type	string	Der Ressourcentyp ist eine private Verknüpfungsressource.

PrivateLinkResourceListResult

Objekt

Das Ergebnis einer Anforderung zum Auflisten privater Linkressourcen für eine Containerregistrierung.

Name	Typ	Beschreibung
nextLink	string	Der URI, der verwendet werden kann, um die nächste Liste der privaten Linkressourcen anzufordern.
value	PrivateLinkResource[]	Die Liste der privaten Linkressourcen. Da diese Liste möglicherweise unvollständig ist, sollte das nextLink-Feld verwendet werden, um die nächste Liste der privaten Linkressourcen anzufordern.