Private Endpoint Connections - List By Service

Service:: Search Management

API-versie:: 2023-11-01

Hiermee haalt u een lijst op met alle privé-eindpuntverbindingen in de opgegeven service.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName	path	True	string	De naam van de zoekservice die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId	path	True	string	De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API, opdrachtregelprogramma's of de portal.
api-version	query	True	string	De API-versie die voor elke aanvraag moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Name	Type	Description
200 OK	PrivateEndpointConnectionListResult	De bewerking is voltooid. Het antwoord bevat de lijst met alle privé-eindpuntverbindingen voor de opgegeven service.
Other Status Codes	CloudError	Er is een onverwachte fout opgetreden tijdens de bewerking.

Beveiliging

azure_auth

Autorisatiestroom voor Microsoft Entra-id OAuth2.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ListPrivateEndpointConnectionsByService

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
PrivateEndpoint	De privé-eindpuntresource van de Microsoft.Network-provider.
PrivateEndpointConnection	Beschrijft een bestaande privé-eindpuntverbinding met de zoekservice.
PrivateEndpointConnectionListResult	Antwoord met een lijst met privé-eindpuntverbindingen.
PrivateEndpointConnectionProperties	Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.
PrivateLinkServiceConnectionProvisioningState	De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig
PrivateLinkServiceConnectionState	Beschrijft de huidige status van een bestaande Private Link-serviceverbinding met het Privé-eindpunt van Azure.
PrivateLinkServiceConnectionStatus	Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

CloudError

Object

Bevat informatie over een API-fout.

Name	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

PrivateEndpoint

Object

De privé-eindpuntresource van de Microsoft.Network-provider.

Name	Type	Description
id	string	De resource-id van de privé-eindpuntresource van de Microsoft.Network-provider.

PrivateEndpointConnection

Object

Beschrijft een bestaande privé-eindpuntverbinding met de zoekservice.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties	PrivateEndpointConnectionProperties	Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionListResult

Object

Antwoord met een lijst met privé-eindpuntverbindingen.

Name	Type	Description
nextLink	string	Aanvraag-URL die kan worden gebruikt om een query uit te voeren op de volgende pagina met privé-eindpuntverbindingen. Geretourneerd wanneer het totale aantal aangevraagde privé-eindpuntverbindingen de maximale paginagrootte overschrijdt.
value	PrivateEndpointConnection[]	De lijst met privé-eindpuntverbindingen.

PrivateEndpointConnectionProperties

Object

Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.

Name	Type	Description
groupId	string	De groeps-id van de provider van de resource waarvoor de private link-serviceverbinding geldt.
privateEndpoint	PrivateEndpoint	De privé-eindpuntresource van de Microsoft.Network-provider.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Beschrijft de huidige status van een bestaande Private Link-serviceverbinding met het Privé-eindpunt van Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig

PrivateLinkServiceConnectionProvisioningState

Opsomming

De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig

Waarde	Description
Updating	De private link-serviceverbinding wordt in het proces gemaakt, samen met andere resources, zodat deze volledig functioneel is.
Deleting	De private link-serviceverbinding wordt verwijderd.
Failed	De private link-serviceverbinding kan niet worden ingericht of verwijderd.
Succeeded	De private link-serviceverbinding is ingericht en is gereed voor goedkeuring.
Incomplete	De inrichtingsaanvraag voor de private link-serviceverbindingsresource is geaccepteerd, maar het proces van maken is nog niet gestart.
Canceled	Inrichtingsaanvraag voor de private link-serviceverbindingsresource is geannuleerd

PrivateLinkServiceConnectionState

Object

Beschrijft de huidige status van een bestaande Private Link-serviceverbinding met het Privé-eindpunt van Azure.

Name	Type	Default value	Description
actionsRequired	string	None	Een beschrijving van eventuele extra acties die nodig kunnen zijn.
description	string		De beschrijving voor de verbindingsstatus van de Private Link-service.
status	PrivateLinkServiceConnectionStatus		Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

PrivateLinkServiceConnectionStatus

Opsomming

Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

Waarde	Description
Pending	De privé-eindpuntverbinding is gemaakt en wacht op goedkeuring.
Approved	De verbinding met het privé-eindpunt is goedgekeurd en kan worden gebruikt.
Rejected	De privé-eindpuntverbinding is geweigerd en kan niet worden gebruikt.
Disconnected	De privé-eindpuntverbinding is verwijderd uit de service.