Private Endpoint Connections - List

Odwołanie

Service:: Redis Cache

API Version:: 2023-08-01

Wyświetl listę wszystkich połączeń prywatnych punktów końcowych skojarzonych z pamięcią podręczną Redis Cache.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections?api-version=2023-08-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
cacheName	path	True	string	Nazwa pamięci podręcznej Redis Cache. Regex pattern: `^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]\|[a-zA-Z0-9])$`
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateEndpointConnectionListResult	OK — pomyślnie pobrano połączenia prywatnych punktów końcowych.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

RedisCacheListPrivateEndpointConnection

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/redis/cachetest01/privateEndpointConnections?api-version=2023-08-01


/** Samples for PrivateEndpointConnections List. */
public final class Main {
    /*
     * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/
     * RedisCacheListPrivateEndpointConnections.json
     */
    /**
     * Sample code: RedisCacheListPrivateEndpointConnection.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void redisCacheListPrivateEndpointConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.redisCaches().manager().serviceClient().getPrivateEndpointConnections().list("rgtest01", "cachetest01",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.redis import RedisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redis
# USAGE
    python redis_cache_list_private_endpoint_connections.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 = RedisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.private_endpoint_connections.list(
        resource_group_name="rgtest01",
        cache_name="cachetest01",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheListPrivateEndpointConnections.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

package armredis_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redis/armredis/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/20312e2b31df58f0ea7560e87062d62aa92f0a14/specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheListPrivateEndpointConnections.json
func ExamplePrivateEndpointConnectionsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredis.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListPager("rgtest01", "cachetest01", 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.PrivateEndpointConnectionListResult = armredis.PrivateEndpointConnectionListResult{
		// 	Value: []*armredis.PrivateEndpointConnection{
		// 		{
		// 			Name: to.Ptr("pectest01"),
		// 			Type: to.Ptr("Microsoft.Cache/Redis/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01"),
		// 			Properties: &armredis.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armredis.PrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armredis.PrivateLinkServiceConnectionState{
		// 					Description: to.Ptr("Auto-Approved"),
		// 					ActionsRequired: to.Ptr("None"),
		// 					Status: to.Ptr(armredis.PrivateEndpointServiceConnectionStatusApproved),
		// 				},
		// 				ProvisioningState: to.Ptr(armredis.PrivateEndpointConnectionProvisioningStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("pectest01"),
		// 			Type: to.Ptr("Microsoft.Cache/Redis/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01"),
		// 			Properties: &armredis.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armredis.PrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armredis.PrivateLinkServiceConnectionState{
		// 					Description: to.Ptr("Auto-Approved"),
		// 					ActionsRequired: to.Ptr("None"),
		// 					Status: to.Ptr(armredis.PrivateEndpointServiceConnectionStatusApproved),
		// 				},
		// 				ProvisioningState: to.Ptr(armredis.PrivateEndpointConnectionProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to List all the private endpoint connections associated with the redis cache.
 *
 * @summary List all the private endpoint connections associated with the redis cache.
 * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheListPrivateEndpointConnections.json
 */
async function redisCacheListPrivateEndpointConnection() {
  const subscriptionId = process.env["REDIS_SUBSCRIPTION_ID"] || "{subscriptionId}";
  const resourceGroupName = process.env["REDIS_RESOURCE_GROUP"] || "rgtest01";
  const cacheName = "cachetest01";
  const credential = new DefaultAzureCredential();
  const client = new RedisManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateEndpointConnections.list(resourceGroupName, cacheName)) {
    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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Redis;
using Azure.ResourceManager.Redis.Models;

// Generated from example definition: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheListPrivateEndpointConnections.json
// this example is just showing the usage of "PrivateEndpointConnections_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this RedisResource created on azure
// for more information of creating RedisResource, please refer to the document of RedisResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "rgtest01";
string cacheName = "cachetest01";
ResourceIdentifier redisResourceId = RedisResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, cacheName);
RedisResource redis = client.GetRedisResource(redisResourceId);

// get the collection of this RedisPrivateEndpointConnectionResource
RedisPrivateEndpointConnectionCollection collection = redis.GetRedisPrivateEndpointConnections();

// invoke the operation and iterate over the result
await foreach (RedisPrivateEndpointConnectionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    RedisPrivateEndpointConnectionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01",
      "name": "pectest01",
      "type": "Microsoft.Cache/Redis/privateEndpointConnections",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "Auto-Approved",
          "actionsRequired": "None"
        }
      }
    },
    {
      "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01",
      "name": "pectest01",
      "type": "Microsoft.Cache/Redis/privateEndpointConnections",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "Auto-Approved",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
PrivateEndpoint	Zasób prywatnego punktu końcowego.
PrivateEndpointConnection	Zasób połączenia z prywatnym punktem końcowym.
PrivateEndpointConnectionListResult	Lista połączenia prywatnego punktu końcowego skojarzonego z określonym kontem magazynu
PrivateEndpointConnectionProvisioningState	Bieżący stan aprowizacji.
PrivateEndpointServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.

ErrorAdditionalInfo

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

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

ErrorDetail

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

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

PrivateEndpoint

Zasób prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego

PrivateEndpointConnection

Zasób połączenia z prywatnym punktem końcowym.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji zasobu połączenia prywatnego punktu końcowego.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Lista połączenia prywatnego punktu końcowego skojarzonego z określonym kontem magazynu

Nazwa	Typ	Opis
value	PrivateEndpointConnection[]	Tablica połączeń prywatnych punktów końcowych

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

Nazwa	Typ	Opis
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.

Nazwa	Typ	Opis
actionsRequired	string	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
description	string	Przyczyna zatwierdzenia/odrzucenia połączenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.