Private Endpoint Connections - List By Service

Tjänst:: Search Management

API-version:: 2023-11-01

Hämtar en lista över alla privata slutpunktsanslutningar i den angivna tjänsten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
searchServiceName	path	True	string	Namnet på söktjänsten som är associerad med den angivna resursgruppen.
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et, kommandoradsverktygen eller portalen.
api-version	query	True	string	DEN API-version som ska användas för varje begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name	Typ	Description
200 OK	PrivateEndpointConnectionListResult	Åtgärden lyckades. Svaret innehåller listan över alla privata slutpunktsanslutningar för den angivna tjänsten.
Other Status Codes	CloudError	Ett oväntat fel uppstod under åtgärden.

Säkerhet

azure_auth

Auktoriseringsflöde för Microsoft Entra ID OAuth2.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ListPrivateEndpointConnectionsByService

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
        }
      }
    }
  ]
}

Definitioner

Name	Description
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
PrivateEndpoint	Den privata slutpunktsresursen från Microsoft.Network-providern.
PrivateEndpointConnection	Beskriver en befintlig privat slutpunktsanslutning till söktjänsten.
PrivateEndpointConnectionListResult	Svar som innehåller en lista över privata slutpunktsanslutningar.
PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.
PrivateLinkServiceConnectionProvisioningState	Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig
PrivateLinkServiceConnectionState	Beskriver det aktuella tillståndet för en befintlig Private Link-tjänstanslutning till den privata Azure-slutpunkten.
PrivateLinkServiceConnectionStatus	Status för den privata länktjänstanslutningen. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

PrivateEndpoint

Objekt

Den privata slutpunktsresursen från Microsoft.Network-providern.

Name	Typ	Description
id	string	Resurs-ID för den privata slutpunktsresursen från Microsoft.Network-providern.

PrivateEndpointConnection

Objekt

Beskriver en befintlig privat slutpunktsanslutning till söktjänsten.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Objekt

Svar som innehåller en lista över privata slutpunktsanslutningar.

Name	Typ	Description
nextLink	string	Begär URL som kan användas för att fråga nästa sida med privata slutpunktsanslutningar. Returneras när det totala antalet begärda privata slutpunktsanslutningar överskrider den maximala sidstorleken.
value	PrivateEndpointConnection[]	Listan över privata slutpunktsanslutningar.

PrivateEndpointConnectionProperties

Objekt

Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.

Name	Typ	Description
groupId	string	Grupp-ID:t från resursprovidern som den privata länktjänstanslutningen är till för.
privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen från Microsoft.Network-providern.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Beskriver det aktuella tillståndet för en befintlig Private Link-tjänstanslutning till den privata Azure-slutpunkten.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig

PrivateLinkServiceConnectionProvisioningState

Uppräkning

Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig

Värde	Description
Updating	Den privata länktjänstens anslutning håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut.
Deleting	Den privata länktjänstanslutningen håller på att tas bort.
Failed	Det gick inte att etablera eller ta bort den privata länktjänstens anslutning.
Succeeded	Anslutningen till tjänsten private link har slutfört etableringen och är klar för godkännande.
Incomplete	Etableringsbegäran för anslutningsresursen för den privata länktjänsten har godkänts, men processen för att skapa har inte påbörjats ännu.
Canceled	Etableringsbegäran för anslutningsresursen för den privata länktjänsten har avbrutits

PrivateLinkServiceConnectionState

Objekt

Beskriver det aktuella tillståndet för en befintlig Private Link-tjänstanslutning till den privata Azure-slutpunkten.

Name	Typ	Standardvärde	Description
actionsRequired	string	None	En beskrivning av eventuella extra åtgärder som kan krävas.
description	string		Beskrivningen av anslutningstillståndet för tjänsten private link.
status	PrivateLinkServiceConnectionStatus		Status för den privata länktjänstanslutningen. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

PrivateLinkServiceConnectionStatus

Uppräkning

Status för den privata länktjänstanslutningen. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

Värde	Description
Pending	Den privata slutpunktsanslutningen har skapats och väntar på godkännande.
Approved	Den privata slutpunktsanslutningen är godkänd och klar att användas.
Rejected	Den privata slutpunktsanslutningen har avvisats och kan inte användas.
Disconnected	Den privata slutpunktsanslutningen har tagits bort från tjänsten.