SearchExtensions.GetSearchServiceAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the search service with the given name in the given resource group.
- 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 static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Search.SearchServiceResource>> GetSearchServiceAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string searchServiceName, Azure.ResourceManager.Search.Models.SearchManagementRequestOptions searchManagementRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member GetSearchServiceAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * Azure.ResourceManager.Search.Models.SearchManagementRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Search.SearchServiceResource>>
<Extension()>
Public Function GetSearchServiceAsync (resourceGroupResource As ResourceGroupResource, searchServiceName As String, Optional searchManagementRequestOptions As SearchManagementRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchServiceResource))
Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance the method will execute against.
- 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
resourceGroupResource
or searchServiceName
is null.
searchServiceName
is an empty string, and was expected to be non-empty.