Private Endpoint Connections - List By Resource

Referencia

Szolgáltatás:: Event Grid

API-verzió:: 2025-02-15

Az erőforráshoz tartozó összes privát végpontkapcsolatot felsorolja.
Szerezze be az összes privát végpontkapcsolatot egy témakör, tartomány vagy partnernévtér vagy névtér alatt.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections?api-version=2025-02-15

Opcionális paraméterekkel:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections?api-version=2025-02-15&$filter={$filter}&$top={$top}

URI-paraméterek

Name	In	Kötelező	Típus	Description
parentName	path	True	string	A szülőerőforrás neve (vagyis a témakör neve, tartományneve vagy partnernévtér neve vagy névtérneve).
parentType	path	True	PrivateEndpointConnectionsParentType	A szülőerőforrás típusa. Ez lehet "témakörök", "tartományok", "partnerNamespaces" vagy "névterek".
resourceGroupName	path	True	string	A felhasználó előfizetésében lévő erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.
$filter	query		string	A keresési eredmények OData-szintaxissal való szűréséhez használt lekérdezés. A szűrés csak a "name" tulajdonságon engedélyezett, és korlátozott számú OData-művelettel. Ezek a műveletek a következők: a "contains" függvény, valamint a következő logikai műveletek: nem, és, vagy eq (egyenlő) és ne (nem egyenlő). A számtani műveletek nem támogatottak. A következő érvényes szűrő példa: $filter=contains(namE, 'PATTERN') és name ne 'PATTERN-1'. A következő nem érvényes szűrő példa: $filter=location eq 'westus'.
$top	query		integer (int32)	A listaművelet oldalanként visszaadandó eredményeinek száma. A felső paraméter érvényes tartománya 1 és 100 között lehet. Ha nincs megadva, a visszaadandó találatok alapértelmezett száma oldalanként 20 elem.

Válaszok

Name

Típus

Description

200 OK

PrivateEndpointConnectionListResult

OKÉ

Other Status Codes

Hibaválaszok: ***

400 Rossz kérés.
500 belső kiszolgálóhiba.

Példák

PrivateEndpointConnections_ListByResource

Mintakérelem

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections?api-version=2025-02-15


import com.azure.resourcemanager.eventgrid.models.PrivateEndpointConnectionsParentType;

/**
 * Samples for PrivateEndpointConnections ListByResource.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/
     * PrivateEndpointConnections_ListByResource.json
     */
    /**
     * Sample code: PrivateEndpointConnections_ListByResource.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void
        privateEndpointConnectionsListByResource(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.privateEndpointConnections().listByResource("examplerg", PrivateEndpointConnectionsParentType.TOPICS,
            "exampletopic1", null, null, 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.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python private_endpoint_connections_list_by_resource.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 = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.private_endpoint_connections.list_by_resource(
        resource_group_name="examplerg",
        parent_type="topics",
        parent_name="exampletopic1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PrivateEndpointConnections_ListByResource.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 armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PrivateEndpointConnections_ListByResource.json
func ExamplePrivateEndpointConnectionsClient_NewListByResourcePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByResourcePager("examplerg", armeventgrid.PrivateEndpointConnectionsParentTypeTopics, "exampletopic1", &armeventgrid.PrivateEndpointConnectionsClientListByResourceOptions{Filter: nil,
		Top: 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 = armeventgrid.PrivateEndpointConnectionListResult{
		// 	Value: []*armeventgrid.PrivateEndpointConnection{
		// 		{
		// 			Name: to.Ptr("BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
		// 			Type: to.Ptr("Microsoft.EventGrid/topics/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
		// 			Properties: &armeventgrid.PrivateEndpointConnectionProperties{
		// 				GroupIDs: []*string{
		// 					to.Ptr("topic")},
		// 					PrivateEndpoint: &armeventgrid.PrivateEndpoint{
		// 						ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5"),
		// 					},
		// 					PrivateLinkServiceConnectionState: &armeventgrid.ConnectionState{
		// 						Description: to.Ptr("Test"),
		// 						ActionsRequired: to.Ptr("None"),
		// 						Status: to.Ptr(armeventgrid.PersistedConnectionStatusPending),
		// 					},
		// 					ProvisioningState: to.Ptr(armeventgrid.ResourceProvisioningStateSucceeded),
		// 				},
		// 		}},
		// 	}
	}
}

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

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get all private endpoint connections under a topic, domain, or partner namespace or namespace.
 *
 * @summary Get all private endpoint connections under a topic, domain, or partner namespace or namespace.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PrivateEndpointConnections_ListByResource.json
 */
async function privateEndpointConnectionsListByResource() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const parentType = "topics";
  const parentName = "exampletopic1";
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.privateEndpointConnections.listByResource(
    resourceGroupName,
    parentType,
    parentName,
  )) {
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventGrid.Models;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/PrivateEndpointConnections_ListByResource.json
// this example is just showing the usage of "PrivateEndpointConnections_ListByResource" 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 EventGridTopicResource created on azure
// for more information of creating EventGridTopicResource, please refer to the document of EventGridTopicResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string parentName = "exampletopic1";
ResourceIdentifier eventGridTopicResourceId = EventGridTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, parentName);
EventGridTopicResource eventGridTopic = client.GetEventGridTopicResource(eventGridTopicResourceId);

// get the collection of this EventGridTopicPrivateEndpointConnectionResource
EventGridTopicPrivateEndpointConnectionCollection collection = eventGridTopic.GetEventGridTopicPrivateEndpointConnections();

// invoke the operation and iterate over the result
await foreach (EventGridTopicPrivateEndpointConnectionResource 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
    EventGridPrivateEndpointConnectionData 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

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "properties": {
        "privateEndpoint": {
          "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5"
        },
        "groupIds": [
          "topic"
        ],
        "privateLinkServiceConnectionState": {
          "status": "Pending",
          "description": "Test",
          "actionsRequired": "None"
        },
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B",
      "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B",
      "type": "Microsoft.EventGrid/topics/privateEndpointConnections"
    }
  ]
}

Definíciók

Name	Description
ConnectionState	ConnectionState-információk.
PersistedConnectionStatus	A kapcsolat állapota.
PrivateEndpoint	PrivateEndpoint-információk.
PrivateEndpointConnection
PrivateEndpointConnectionListResult	Az összes privát végpontkapcsolati művelet listájának eredménye.
PrivateEndpointConnectionsParentType	A szülőerőforrás típusa. Ez lehet "témakörök", "tartományok", "partnerNamespaces" vagy "névterek".
ResourceProvisioningState	A privát végpontkapcsolat kiépítési állapota.

ConnectionState

Objektum

ConnectionState-információk.

Name	Típus	Description
actionsRequired	string	Szükséges műveletek (ha vannak ilyenek).
description	string	A kapcsolat állapotának leírása.
status	PersistedConnectionStatus	A kapcsolat állapota.

PersistedConnectionStatus

Enumerálás

A kapcsolat állapota.

Érték	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Objektum

PrivateEndpoint-információk.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója.

PrivateEndpointConnection

Objektum

Name	Típus	Description
id	string	Az erőforrás teljes azonosítója.
name	string	Az erőforrás neve.
properties.groupIds	string[]	GroupIds a privát kapcsolat szolgáltatás erőforrásából.
properties.privateEndpoint	PrivateEndpoint	A kapcsolat privát végpont-erőforrása.
properties.privateLinkServiceConnectionState	ConnectionState	A kapcsolat állapotának részletei.
properties.provisioningState	ResourceProvisioningState	A privát végpontkapcsolat kiépítési állapota.
type	string	Az erőforrás típusa.

PrivateEndpointConnectionListResult

Objektum

Az összes privát végpontkapcsolati művelet listájának eredménye.

Name	Típus	Description
nextLink	string	A privát végpont kapcsolati erőforrásainak következő oldalára mutató hivatkozás.
value	PrivateEndpointConnection[]	Privát végpont kapcsolati erőforrásainak gyűjteménye.

PrivateEndpointConnectionsParentType

Enumerálás

A szülőerőforrás típusa. Ez lehet "témakörök", "tartományok", "partnerNamespaces" vagy "névterek".

Érték	Description
domains
namespaces
partnerNamespaces
topics

ResourceProvisioningState

Enumerálás

A privát végpontkapcsolat kiépítési állapota.

Érték	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating