IIndexesOperations.DeleteWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Search

Assembly:: Microsoft.Azure.Search.Service.dll

Package:: Microsoft.Azure.Search.Service v10.1.0

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.

Deletes a search index and all the documents it contains. https://docs.microsoft.com/rest/api/searchservice/Delete-Index

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> DeleteWithHttpMessagesAsync (string indexName, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, Microsoft.Azure.Search.Models.AccessCondition accessCondition = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteWithHttpMessagesAsync : string * Microsoft.Azure.Search.Models.SearchRequestOptions * Microsoft.Azure.Search.Models.AccessCondition * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function DeleteWithHttpMessagesAsync (indexName As String, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional accessCondition As AccessCondition = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

indexName: String

The name of the index to delete.

searchRequestOptions: SearchRequestOptions

Additional parameters for the operation

accessCondition: AccessCondition

Additional parameters for the operation

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

Applies to