SearchIndexerClient.DeleteDataSourceConnectionAsync 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.
Overloads
| Name | Description |
|---|---|
| DeleteDataSourceConnectionAsync(String, CancellationToken) |
Deletes a data source connection. |
| DeleteDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, CancellationToken) |
Deletes a data source connection. |
| DeleteDataSourceConnectionAsync(String, MatchConditions, RequestContext) |
[Protocol Method] Deletes a datasource.
|
| DeleteDataSourceConnectionAsync(String, MatchConditions, CancellationToken) |
Deletes a datasource. |
DeleteDataSourceConnectionAsync(String, CancellationToken)
Deletes a data source connection.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDataSourceConnectionAsync(string dataSourceConnectionName, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDataSourceConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDataSourceConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteDataSourceConnectionAsync (dataSourceConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- dataSourceConnectionName
- String
The name of the SearchIndexerDataSourceConnection to delete.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be canceled.
Returns
The Response from the server.
Exceptions
Thrown when dataSourceConnectionName is null.
Thrown when a failure is returned by the Search service.
Applies to
DeleteDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, CancellationToken)
Deletes a data source connection.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDataSourceConnectionAsync(Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection dataSourceConnection, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDataSourceConnectionAsync : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDataSourceConnectionAsync : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteDataSourceConnectionAsync (dataSourceConnection As SearchIndexerDataSourceConnection, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- dataSourceConnection
- SearchIndexerDataSourceConnection
The SearchIndexerDataSourceConnection to delete.
- onlyIfUnchanged
- Boolean
True to throw a RequestFailedException if the ETag does not match the current service version; otherwise, the current service version will be overwritten.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be canceled.
Returns
The Response from the server.
Exceptions
Thrown when dataSourceConnection is null.
Thrown when a failure is returned by the Search service.
Applies to
DeleteDataSourceConnectionAsync(String, MatchConditions, RequestContext)
- Source:
- SearchIndexerClient.cs
- Source:
- SearchIndexerClient.cs
[Protocol Method] Deletes a datasource.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDataSourceConnectionAsync(string dataSourceConnectionName, Azure.MatchConditions matchConditions, Azure.RequestContext context);abstract member DeleteDataSourceConnectionAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDataSourceConnectionAsync : string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteDataSourceConnectionAsync (dataSourceConnectionName As String, matchConditions As MatchConditions, context As RequestContext) As Task(Of Response)Parameters
- dataSourceConnectionName
- String
The name of the datasource.
- matchConditions
- MatchConditions
The content to send as the request conditions of the request.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
dataSourceConnectionName is null.
dataSourceConnectionName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
DeleteDataSourceConnectionAsync(String, MatchConditions, CancellationToken)
- Source:
- SearchIndexerClient.cs
- Source:
- SearchIndexerClient.cs
Deletes a datasource.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDataSourceConnectionAsync(string dataSourceConnectionName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDataSourceConnectionAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDataSourceConnectionAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteDataSourceConnectionAsync (dataSourceConnectionName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- dataSourceConnectionName
- String
The name of the datasource.
- matchConditions
- MatchConditions
The content to send as the request conditions of the request.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
dataSourceConnectionName is null.
dataSourceConnectionName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
