Private Endpoint Connections - List By Service

Služba:: Search Management

Verze rozhraní API:: 2025-05-01

Získá seznam všech připojení privátních koncových bodů v dané službě.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Název služby Azure AI Search přidružené k zadané skupině prostředků.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Odpovědi

Name	Typ	Description
200 OK	PrivateEndpointConnectionListResult	Požadavek byl úspěšný.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ListPrivateEndpointConnectionsByService

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2025-05-01

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/v2"
)

// Generated from example definition: 2025-05-01/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("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByServicePager("rg1", "mysearchservice", 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 = armsearch.PrivateEndpointConnectionsClientListByServiceResponse{
		// 	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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 				Properties: &armsearch.PrivateEndpointConnectionProperties{
		// 					PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
createdByType	Typ identity, která prostředek vytvořila.
PrivateEndpointConnection	Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search.
PrivateEndpointConnectionListResult	Odpověď obsahující seznam připojení privátních koncových bodů
PrivateEndpointConnectionProperties	Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.
PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.
PrivateLinkServiceConnectionStatus	Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
message	string	Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

PrivateEndpointConnection

Objekt

Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties	PrivateEndpointConnectionProperties	Popisuje vlastnosti existujícího připojení privátního koncového bodu ke službě Azure AI Search.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionListResult

Objekt

Odpověď obsahující seznam připojení privátních koncových bodů

Name	Typ	Description
nextLink	string	Adresa URL požadavku, která se dá použít k dotazování na další stránku připojení privátního koncového bodu. Vrátí se, když celkový počet požadovaných připojení privátních koncových bodů překročí maximální velikost stránky.
value	PrivateEndpointConnection[]	Seznam připojení privátních koncových bodů

PrivateEndpointConnectionProperties

Objekt

Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.

Name	Typ	Description
groupId	string	ID skupiny prostředku Azure, pro který je služba private link určená.
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Objekt

Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.

Name	Typ	Description
id	string	ID prostředku prostředku privátního koncového bodu od poskytovatele Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Objekt

Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.

Name	Typ	Default value	Description
actionsRequired	string	None	Popis všech dodatečných akcí, které mohou být vyžadovány.
description	string		Popis stavu připojení služby Private Link.
status	PrivateLinkServiceConnectionStatus		Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

PrivateLinkServiceConnectionProvisioningState

Výčet

Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.

Hodnota	Description
Updating	Připojení služby Private Link probíhá v procesu vytváření spolu s dalšími prostředky, aby bylo plně funkční.
Deleting	Připojení služby Private Link probíhá v procesu odstranění.
Failed	Připojení služby Private Link se nepodařilo zřídit nebo odstranit.
Succeeded	Připojení služby Private Link dokončilo zřizování a je připravené ke schválení.
Incomplete	Žádost o zřízení prostředku připojení služby Private Link byla přijata, ale proces vytvoření ještě nebyl zahájen.
Canceled	Žádost o zřízení prostředku připojení služby Private Link byla zrušena.

PrivateLinkServiceConnectionStatus

Výčet

Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Hodnota	Description
Pending	Připojení privátního koncového bodu se vytvořilo a čeká na schválení.
Approved	Připojení privátního koncového bodu je schválené a je připravené k použití.
Rejected	Připojení privátního koncového bodu bylo odmítnuto a nelze ho použít.
Disconnected	Připojení privátního koncového bodu bylo ze služby odebráno.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.