Private Endpoint Connections - List By Service

Odwołanie

Usługa:: Search Management

Wersja interfejsu API:: 2023-11-01

Pobiera listę wszystkich połączeń prywatnych punktów końcowych w danej usłudze.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections?api-version=2023-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
searchServiceName	path	True	string	Nazwa usługi wyszukiwania skojarzonej z określoną grupą zasobów.
subscriptionId	path	True	string	Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager, narzędzi wiersza polecenia lub portalu.
api-version	query	True	string	Wersja interfejsu API do użycia dla każdego żądania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string uuid	Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach odpowiedzi jako sposób śledzenia żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateEndpointConnectionListResult	Operacja zakończyła się pomyślnie. Odpowiedź zawiera listę wszystkich połączeń prywatnych punktów końcowych dla danej usługi.
Other Status Codes	CloudError	Podczas tej operacji wystąpił niespodziewany błąd.

Zabezpieczenia

azure_auth

Tożsamość Microsoft Entra przepływ autoryzacji OAuth2.

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

ListPrivateEndpointConnectionsByService

Przykładowe żądanie

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2023-11-01


/**
 * Samples for PrivateEndpointConnections ListByService.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * ListPrivateEndpointConnectionsByService.json
     */
    /**
     * Sample code: ListPrivateEndpointConnectionsByService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listPrivateEndpointConnectionsByService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getPrivateEndpointConnections().listByService("rg1",
            "mysearchservice", 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.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python list_private_endpoint_connections_by_service.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 = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.private_endpoint_connections.list_by_service(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.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 armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.json
func ExamplePrivateEndpointConnectionsClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByServicePager("rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, 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 = armsearch.PrivateEndpointConnectionListResult{
		// 	Value: []*armsearch.PrivateEndpointConnection{
		// 		{
		// 			Name: to.Ptr("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 			Properties: &armsearch.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
		// 					Description: to.Ptr(""),
		// 					ActionsRequired: to.Ptr("None"),
		// 					Status: to.Ptr(armsearch.PrivateLinkServiceConnectionStatusApproved),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Gets a list of all private endpoint connections in the given service.
 *
 * @summary Gets a list of all private endpoint connections in the given service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.json
 */
async function listPrivateEndpointConnectionsByService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateEndpointConnections.listByService(
    resourceGroupName,
    searchServiceName
  )) {
    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.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/ListPrivateEndpointConnectionsByService.json
// this example is just showing the usage of "PrivateEndpointConnections_ListByService" 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 SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// get the collection of this SearchPrivateEndpointConnectionResource
SearchPrivateEndpointConnectionCollection collection = searchService.GetSearchPrivateEndpointConnections();

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "type": "Microsoft.Search/searchServices/privateEndpointConnections",
      "properties": {
        "privateEndpoint": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
PrivateEndpoint	Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.
PrivateEndpointConnection	Opisuje istniejące połączenie prywatnego punktu końcowego z usługą wyszukiwania.
PrivateEndpointConnectionListResult	Odpowiedź zawierająca listę połączeń z prywatnym punktem końcowym.
PrivateEndpointConnectionProperties	Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.
PrivateLinkServiceConnectionProvisioningState	Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne
PrivateLinkServiceConnectionState	Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.
PrivateLinkServiceConnectionStatus	Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

CloudError

Zawiera informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.
details	CloudErrorBody[]	Zawiera zagnieżdżone błędy związane z tym błędem.
message	string	Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

PrivateEndpoint

Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu prywatnego punktu końcowego od dostawcy Microsoft.Network.

PrivateEndpointConnection

Opisuje istniejące połączenie prywatnego punktu końcowego z usługą wyszukiwania.

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	PrivateEndpointConnectionProperties	Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Odpowiedź zawierająca listę połączeń z prywatnym punktem końcowym.

Nazwa	Typ	Opis
nextLink	string	Adres URL żądania, który może służyć do wysyłania zapytań do następnej strony połączeń prywatnych punktów końcowych. Zwracany, gdy łączna liczba żądanych połączeń prywatnych punktów końcowych przekracza maksymalny rozmiar strony.
value	PrivateEndpointConnection[]	Lista połączeń z prywatnym punktem końcowym.

PrivateEndpointConnectionProperties

Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.

Nazwa	Typ	Opis
groupId	string	Identyfikator grupy od dostawcy zasobu jest przeznaczony dla połączenia usługi private link.
privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne

PrivateLinkServiceConnectionProvisioningState

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne

Nazwa	Typ	Opis
Canceled	string	Żądanie aprowizacji zasobu połączenia usługi Private Link zostało anulowane
Deleting	string	Połączenie usługi łącza prywatnego jest w trakcie usuwania.
Failed	string	Nie można aprowizować ani usunąć połączenia usługi łącza prywatnego.
Incomplete	string	Żądanie aprowizacji zasobu połączenia usługi Private Link zostało zaakceptowane, ale proces tworzenia nie został jeszcze rozpoczęty.
Succeeded	string	Połączenie usługi private link zakończyło aprowizację i jest gotowe do zatwierdzenia.
Updating	string	Połączenie usługi łącza prywatnego jest w trakcie tworzenia wraz z innymi zasobami, które mają być w pełni funkcjonalne.

PrivateLinkServiceConnectionState

Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.

Nazwa	Typ	Domyślna wartość	Opis
actionsRequired	string	None	Opis wszelkich dodatkowych akcji, które mogą być wymagane.
description	string		Opis stanu połączenia usługi łącza prywatnego.
status	PrivateLinkServiceConnectionStatus		Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

PrivateLinkServiceConnectionStatus

Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Nazwa	Typ	Opis
Approved	string	Połączenie prywatnego punktu końcowego jest zatwierdzone i jest gotowe do użycia.
Disconnected	string	Połączenie prywatnego punktu końcowego zostało usunięte z usługi.
Pending	string	Połączenie prywatnego punktu końcowego zostało utworzone i oczekuje na zatwierdzenie.
Rejected	string	Połączenie prywatnego punktu końcowego zostało odrzucone i nie można go użyć.