SearchIndexerClient.CreateOrUpdateDataSourceConnectionAsync Method

Definition

Creates a new data source or updates an existing data source connection.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection>> CreateOrUpdateDataSourceConnectionAsync (Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection dataSourceConnection, bool onlyIfUnchanged = false, bool? ignoreCacheResetRequirements = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateDataSourceConnectionAsync : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection>>
override this.CreateOrUpdateDataSourceConnectionAsync : Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection * bool * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerDataSourceConnection>>
Public Overridable Function CreateOrUpdateDataSourceConnectionAsync (dataSourceConnection As SearchIndexerDataSourceConnection, Optional onlyIfUnchanged As Boolean = false, Optional ignoreCacheResetRequirements As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchIndexerDataSourceConnection))

Parameters

dataSourceConnection
SearchIndexerDataSourceConnection

Required. The SearchIndexerDataSourceConnection to create or update.

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.

ignoreCacheResetRequirements
Nullable<Boolean>

True if the cache reset requirements should be ignored.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

The Response<T> from the server containing the SearchIndexerDataSourceConnection that was created. This may differ slightly from what was passed in since the service may return back properties set to their default values.

Exceptions

Thrown when dataSourceConnection is null.

Thrown when a failure is returned by the Search service.

Applies to