Private Endpoint Connections - List By Service

Szolgáltatás:: Search Management

API-verzió:: 2023-11-01

Lekéri az adott szolgáltatás összes privát végpontkapcsolatának listáját.

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
searchServiceName	path	True	string	A megadott erőforráscsoporthoz társított keresési szolgáltatás neve.
subscriptionId	path	True	string	A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, a parancssori eszközökből vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használandó API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Válaszok

Név	Típus	Description
200 OK	PrivateEndpointConnectionListResult	A művelet sikeres volt. A válasz tartalmazza az adott szolgáltatáshoz tartozó összes privát végpontkapcsolat listáját.
Other Status Codes	CloudError	Váratlan hiba történt a művelet során.

Biztonság

azure_auth

Microsoft Entra ID OAuth2 engedélyezési folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ListPrivateEndpointConnectionsByService

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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"
        }
      }
    }
  ]
}

Definíciók

Név	Description
CloudError	Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
PrivateEndpoint	A Microsoft.Network szolgáltató magánvégpont-erőforrása.
PrivateEndpointConnection	A keresési szolgáltatás meglévő privát végpontkapcsolatát ismerteti.
PrivateEndpointConnectionListResult	A privát végpontkapcsolatok listáját tartalmazó válasz.
PrivateEndpointConnectionProperties	A keresési szolgáltatáshoz tartozó meglévő privát végpontkapcsolat tulajdonságait ismerteti.
PrivateLinkServiceConnectionProvisioningState	A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos
PrivateLinkServiceConnectionState	Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.
PrivateLinkServiceConnectionStatus	A privát kapcsolat szolgáltatáskapcsolat állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

CloudError

Tárgy

Api-hibával kapcsolatos információkat tartalmaz.

Név	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

CloudErrorBody

Tárgy

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Név	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

PrivateEndpoint

Tárgy

A Microsoft.Network szolgáltató magánvégpont-erőforrása.

Név	Típus	Description
id	string	A Microsoft.Network szolgáltató magánvégpont-erőforrásának erőforrás-azonosítója.

PrivateEndpointConnection

Tárgy

A keresési szolgáltatás meglévő privát végpontkapcsolatát ismerteti.

Név	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	PrivateEndpointConnectionProperties	A keresési szolgáltatással létesített meglévő privát végpontkapcsolat tulajdonságait ismerteti.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Tárgy

A privát végpontkapcsolatok listáját tartalmazó válasz.

Név	Típus	Description
nextLink	string	Kérelem URL-címe, amely a privát végpontkapcsolatok következő oldalának lekérdezésére használható. Akkor adja vissza, ha a kért privát végpontkapcsolatok száma meghaladja a maximális oldalméretet.
value	PrivateEndpointConnection[]	A privát végpont kapcsolatainak listája.

PrivateEndpointConnectionProperties

Tárgy

A keresési szolgáltatáshoz tartozó meglévő privát végpontkapcsolat tulajdonságait ismerteti.

Név	Típus	Description
groupId	string	Annak az erőforrásnak a csoportazonosítója, amelynek a magánhálózati kapcsolat szolgáltatáskapcsolata van.
privateEndpoint	PrivateEndpoint	A Microsoft.Network szolgáltató magánvégpont-erőforrása.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.
provisioningState	PrivateLinkServiceConnectionProvisioningState	A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos

PrivateLinkServiceConnectionProvisioningState

Felsorolás

A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos

Érték	Description
Updating	A privát kapcsolat szolgáltatáskapcsolat létrehozása folyamatban van más erőforrásokkal együtt, hogy teljes mértékben működőképes legyen.
Deleting	A privát kapcsolat szolgáltatáskapcsolat törlése folyamatban van.
Failed	A privát kapcsolat szolgáltatáskapcsolat kiépítése vagy törlése nem sikerült.
Succeeded	A privát kapcsolat szolgáltatáskapcsolata befejezte a kiépítést, és készen áll a jóváhagyásra.
Incomplete	A privát kapcsolati szolgáltatás kapcsolati erőforrásának kiépítési kérése elfogadva, de a létrehozási folyamat még nem kezdődött el.
Canceled	A privát kapcsolati szolgáltatás kapcsolati erőforrásának kiépítési kérése megszakadt

PrivateLinkServiceConnectionState

Tárgy

Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.

Név	Típus	Alapértelmezett érték	Description
actionsRequired	string	None	Az esetlegesen szükséges további műveletek leírása.
description	string		A privát kapcsolati szolgáltatás kapcsolati állapotának leírása.
status	PrivateLinkServiceConnectionStatus		A privát kapcsolat szolgáltatáskapcsolat állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

PrivateLinkServiceConnectionStatus

Felsorolás

A privát kapcsolat szolgáltatáskapcsolat állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

Érték	Description
Pending	A privát végpontkapcsolat létrejött, és jóváhagyásra vár.
Approved	A privát végpontkapcsolat jóvá van hagyva, és használatra kész.
Rejected	A privát végpont kapcsolata elutasítva, és nem használható.
Disconnected	A privát végpont kapcsolata el lett távolítva a szolgáltatásból.