SearchIndexClient.DeleteIndexAsync Método

Definição

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Pacote:

Azure.Search.Documents v11.5.1

Sobrecargas

DeleteIndexAsync(String, CancellationToken)	Exclui um índice de pesquisa e todos os documentos que ele contém.
DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)	Exclui um índice de pesquisa e todos os documentos que ele contém.

DeleteIndexAsync(String, CancellationToken)

Origem:

SearchIndexClient.cs

Exclui um índice de pesquisa e todos os documentos que ele contém.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteIndexAsync (string indexName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIndexAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteIndexAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteIndexAsync (indexName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parâmetros

indexName

String

Obrigatórios. O nome da SearchIndex a ser excluída.

cancellationToken

CancellationToken

Opcional CancellationToken para propagar notificações de que a operação deve ser cancelada.

Retornos

Task<Response>

O Response do servidor.

Exceções

ArgumentNullException

Lançado quando indexName é nulo.

RequestFailedException

Gerada quando uma falha é retornada pelo serviço Pesquisa.

DeleteIndexAsync(SearchIndex, Boolean, CancellationToken)

Origem:

SearchIndexClient.cs

Exclui um índice de pesquisa e todos os documentos que ele contém.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteIndexAsync (Azure.Search.Documents.Indexes.Models.SearchIndex index, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIndexAsync : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteIndexAsync : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteIndexAsync (index As SearchIndex, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parâmetros

index

SearchIndex

Obrigatórios. O SearchIndex a ser excluído.

onlyIfUnchanged

Boolean

True para gerar um RequestFailedException se o ETag não corresponder à versão de serviço atual; caso contrário, a versão do serviço atual será substituída.

cancellationToken

CancellationToken

Opcional CancellationToken para propagar notificações de que a operação deve ser cancelada.

Retornos

Task<Response>

O Response do servidor.

Exceções

ArgumentNullException

Lançado quando index é nulo.

RequestFailedException

Gerada quando uma falha é retornada pelo serviço Pesquisa.