SearchIndexClient.CreateOrUpdateIndexAsync メソッド

定義

名前空間:

Azure.Search.Documents.Indexes

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

ソース:

SearchIndexClient.cs

新しい検索インデックスを作成するか、既存のインデックスを更新します。

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

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

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

パラメーター

index

SearchIndex

必須。 SearchIndex作成または更新する 。

allowIndexDowntime

Boolean

インデックスを一時的に数秒間オフラインにすることで、アナライザー、トークナイザー、トークン フィルター、または文字フィルターをインデックスに追加できるかどうかを示す省略可能な値。 既定値は false です。 これにより、インデックス作成とクエリが一時的に失敗します。 インデックスを更新すると、インデックスのパフォーマンスと書き込み可用性が数分にわたり損なわれる場合があります。インデックスが非常に大きい場合、その時間も長くなります。

onlyIfUnchanged

Boolean

が現在のETagサービス バージョンと一致しない場合は をスローRequestFailedExceptionする場合は True、それ以外の場合は、現在のサービス バージョンが上書きされます。

cancellationToken

CancellationToken

操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Task<Response<SearchIndex>>

Response<T>作成または更新された をSearchIndex含むサーバーの 。 これは、フィールドの種類やその他のプロパティに応じて既定値に設定されたフィールドが返される場合があるため、渡されたものとは若干異なる場合があります。

例外

ArgumentNullException

index が null の場合にスローされます。

RequestFailedException

Search Serviceによってエラーが返されたときにスローされます。