Share via


SearchServiceResource.GetSearchPrivateEndpointConnectionAsync Method

Definition

Gets the details of the private endpoint connection to the search service in the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchPrivateEndpointConnectionResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Search.SearchPrivateEndpointConnectionResource>> GetSearchPrivateEndpointConnectionAsync (string privateEndpointConnectionName, Azure.ResourceManager.Search.Models.SearchManagementRequestOptions searchManagementRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSearchPrivateEndpointConnectionAsync : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Search.SearchPrivateEndpointConnectionResource>>
override this.GetSearchPrivateEndpointConnectionAsync : string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Search.SearchPrivateEndpointConnectionResource>>
Public Overridable Function GetSearchPrivateEndpointConnectionAsync (privateEndpointConnectionName As String, Optional searchManagementRequestOptions As SearchManagementRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchPrivateEndpointConnectionResource))

Parameters

privateEndpointConnectionName
String

The name of the private endpoint connection to the Azure AI Search service with the specified resource group.

searchManagementRequestOptions
SearchManagementRequestOptions

Parameter group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

privateEndpointConnectionName is null.

privateEndpointConnectionName is an empty string, and was expected to be non-empty.

Applies to