Private Endpoint Connections - List By Service

Služba:: Search Management

Verze rozhraní API:: 2023-11-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=2023-11-01

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
searchServiceName	path	True	string	Název vyhledávací služby přidružené k zadané skupině prostředků.
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru, nástrojů příkazového řádku nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Název	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

Název	Typ	Description
200 OK	PrivateEndpointConnectionListResult	Operace byla úspěšná. Odpověď obsahuje seznam všech připojení privátních koncových bodů pro danou službu.
Other Status Codes	CloudError	Během operace došlo k neočekávané chybě.

Zabezpečení

azure_auth

Tok autorizace Microsoft Entra ID OAuth2

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

Rozsahy

Název	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ListPrivateEndpointConnectionsByService

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
        }
      }
    }
  ]
}

Definice

Název	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
PrivateEndpoint	Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
PrivateEndpointConnection	Popisuje existující připojení privátního koncového bodu k vyhledávací službě.
PrivateEndpointConnectionListResult	Odpověď obsahující seznam připojení privátního koncového bodu
PrivateEndpointConnectionProperties	Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.
PrivateLinkServiceConnectionProvisioningState	Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěch nebo Neúplné.
PrivateLinkServiceConnectionState	Popisuje aktuální stav existujícího připojení služby Private Link k privátnímu koncovému bodu Azure.
PrivateLinkServiceConnectionStatus	Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Název	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Objekt

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

Název	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ě).

PrivateEndpoint

Objekt

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

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

PrivateEndpointConnection

Objekt

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

Název	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Pří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 k vyhledávací službě.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionListResult

Objekt

Odpověď obsahující seznam připojení privátního koncového bodu

Název	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ě.

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

PrivateLinkServiceConnectionProvisioningState

Výčet

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

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.

PrivateLinkServiceConnectionState

Objekt

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

Název	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é.

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.