Share via


SearchServiceCollection.GetIfExistsAsync Method

Definition

Tries to get details for this resource from the service.

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

Parameters

searchServiceName
String

The name of the Azure AI Search service associated with the specified resource group.

searchManagementRequestOptions
SearchManagementRequestOptions

Parameter group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

searchServiceName is null.

Applies to