SearchClient.DeleteDocumentsAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken) |
キーのみが指定されたバッチとして、インデックスからドキュメントを削除します。 |
| DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken) |
バッチとしてインデックスからドキュメントを削除します。 |
DeleteDocumentsAsync(String, IEnumerable<String>, IndexDocumentsOptions, CancellationToken)
- ソース:
- SearchClient.cs
- ソース:
- SearchClient.cs
キーのみが指定されたバッチとして、インデックスからドキュメントを削除します。
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync (string keyName, System.Collections.Generic.IEnumerable<string> keyValues, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDocumentsAsync : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.DeleteDocumentsAsync : string * seq<string> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>Public Overridable Function DeleteDocumentsAsync (keyName As String, keyValues As IEnumerable(Of String), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))パラメーター
- keyName
- String
インデックス内のドキュメントを一意に識別するキー フィールドの名前。
- keyValues
- IEnumerable<String>
削除するドキュメントのキー。
- options
- IndexDocumentsOptions
ドキュメントのインデックス作成動作を指定できるオプション。
- cancellationToken
- CancellationToken
操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。
戻り値
アクションのバッチ内のすべてのアクションの操作の状態を含む応答。
例外
Search Service によってエラーが返されたときにスローされます。
注釈
既定では、要求全体が失敗した場合にのみ例外がスローされます。 個々のエラーについては、コレクションで Results 説明します。 部分的な障害時に例外をスローする場合は、 を設定 ThrowOnAnyError できます。
適用対象
DeleteDocumentsAsync<T>(IEnumerable<T>, IndexDocumentsOptions, CancellationToken)
- ソース:
- SearchClient.cs
- ソース:
- SearchClient.cs
バッチとしてインデックスからドキュメントを削除します。
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> DeleteDocumentsAsync<T> (System.Collections.Generic.IEnumerable<T> documents, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.DeleteDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>Public Overridable Function DeleteDocumentsAsync(Of T) (documents As IEnumerable(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))型パラメーター
- T
インデックス スキーマにマップされる .NET 型。 この型のインスタンスは、インデックスからドキュメントとして取得できます。
パラメーター
- documents
- IEnumerable<T>
削除するドキュメント。
- options
- IndexDocumentsOptions
ドキュメントのインデックス作成動作を指定できるオプション。
- cancellationToken
- CancellationToken
操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。
戻り値
アクションのバッチ内のすべてのアクションの操作の状態を含む応答。
例外
Search Service によってエラーが返されたときにスローされます。
注釈
DeleteDocuments メソッドと DeleteDocumentsAsync メソッドのジェネリック オーバーロードでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。型マッピングの詳細については、 を参照してください GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) 。
既定では、要求全体が失敗した場合にのみ例外がスローされます。 個々のエラーについては、コレクションで Results 説明します。 部分的な障害時に例外をスローする場合は、 を設定 ThrowOnAnyError できます。
適用対象
Azure SDK for .NET