Private Link Resources - List By Private Link Scope

Usługa:

Kubernetes Configuration

Wersja interfejsu API:

2024-11-01-preview

Pobiera zasoby łącza prywatnego, które należy utworzyć dla usługi Azure Monitor PrivateLinkScope.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateLinkResources?api-version=2024-11-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
scopeName	path	True	string	Nazwa zasobu Azure Arc PrivateLinkScope.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateLinkResourceListResult	Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Gets private endpoint connection.

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/myPrivateLinkScope/privateLinkResources?api-version=2024-11-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.kubernetesconfiguration.privatelinkscopes import KubernetesConfigurationPrivateLinkScopesMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-kubernetesconfiguration-privatelinkscopes
# USAGE
    python private_link_scope_private_link_resource_list_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KubernetesConfigurationPrivateLinkScopesMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.private_link_resources.list_by_private_link_scope(
        resource_group_name="myResourceGroup",
        scope_name="myPrivateLinkScope",
    )
    print(response)


# x-ms-original-file: 2024-11-01-preview/PrivateLinkScopePrivateLinkResourceListGet.json
if __name__ == "__main__":
    main()

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

Go

package armprivatelinkscopes_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armprivatelinkscopes"
)

// Generated from example definition: 2024-11-01-preview/PrivateLinkScopePrivateLinkResourceListGet.json
func ExamplePrivateLinkResourcesClient_ListByPrivateLinkScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armprivatelinkscopes.NewClientFactory("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkResourcesClient().ListByPrivateLinkScope(ctx, "myResourceGroup", "myPrivateLinkScope", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armprivatelinkscopes.PrivateLinkResourcesClientListByPrivateLinkScopeResponse{
	// 	PrivateLinkResourceListResult: &armprivatelinkscopes.PrivateLinkResourceListResult{
	// 		Value: []*armprivatelinkscopes.PrivateLinkResource{
	// 			{
	// 				Name: to.Ptr("KubernetesConfiguration"),
	// 				Type: to.Ptr("Microsoft.KubernetesConfiguration/privateLinkScopes/privateLinkResources"),
	// 				ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/myPrivateLinkScope/privateLinkResources/KubernetesConfiguration"),
	// 				Properties: &armprivatelinkscopes.PrivateLinkResourceProperties{
	// 					GroupID: to.Ptr("KubernetesConfiguration"),
	// 					RequiredMembers: []*string{
	// 						to.Ptr("KubernetesConfiguration.ServerDP"),
	// 						to.Ptr("KubernetesConfiguration.K8sConfigurationDP"),
	// 						to.Ptr("KubernetesConfiguration.GuestConfigDP"),
	// 					},
	// 					RequiredZoneNames: []*string{
	// 						to.Ptr("privatelink.his.arc.azure.com"),
	// 						to.Ptr("privatelink.kubernetesconfiguration.azure.com"),
	// 						to.Ptr("privatelink.Guestconfiguration.azure.com"),
	// 					},
	// 				},
	// 			},
	// 		},
	// 	},
	// }
}

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 { PrivateLinkScopesClient } = require("@azure/arm-kubernetesconfiguration-privatelinkscopes");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
 *
 * @summary gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
 * x-ms-original-file: 2024-11-01-preview/PrivateLinkScopePrivateLinkResourceListGet.json
 */
async function getsPrivateEndpointConnection() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new PrivateLinkScopesClient(credential, subscriptionId);
  const result = await client.privateLinkResources.listByPrivateLinkScope(
    "myResourceGroup",
    "myPrivateLinkScope",
  );
  console.log(result);
}

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "name": "KubernetesConfiguration",
      "type": "Microsoft.KubernetesConfiguration/privateLinkScopes/privateLinkResources",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/myPrivateLinkScope/privateLinkResources/KubernetesConfiguration",
      "properties": {
        "groupId": "KubernetesConfiguration",
        "requiredMembers": [
          "KubernetesConfiguration.ServerDP",
          "KubernetesConfiguration.K8sConfigurationDP",
          "KubernetesConfiguration.GuestConfigDP"
        ],
        "requiredZoneNames": [
          "privatelink.his.arc.azure.com",
          "privatelink.kubernetesconfiguration.azure.com",
          "privatelink.Guestconfiguration.azure.com"
        ]
      }
    }
  ]
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
PrivateLinkResource	Zasób łącza prywatnego
PrivateLinkResourceListResult	Odpowiedź operacji listy PrivateLinkResource.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

PrivateLinkResource

Objekt

Zasób łącza prywatnego

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.groupId	string	Identyfikator grupy zasobów łącza prywatnego.
properties.requiredMembers	string[]	Zasób łącza prywatnego wymaga nazwy elementów członkowskich.
properties.requiredZoneNames	string[]	Nazwa strefy DNS zasobu łącza prywatnego łącza prywatnego.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateLinkResourceListResult

Objekt

Odpowiedź operacji listy PrivateLinkResource.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony z elementami
value	PrivateLinkResource[]	Elementy PrivateLinkResource na tej stronie

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.