Indexers - Reset Docs

サービス:: Search Service

API バージョン:: 2026-05-01-preview

データソース内の特定のドキュメントをリセットして、インデクサーによって選択的に再取り込まれるようにします。

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview

省略可能なパラメーターを含む:

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview&overwrite={overwrite}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
indexerName	path	True	string	インデクサーの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
overwrite	query		boolean	falseの場合、キーまたはIDは既存のものに追加されます。 true の場合、このペイロードのキーまたは ID のみが再取り込まれるためにキューに入れられます。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前	型	説明
datasourceDocumentIds	string[]	リセットするデータソース文書識別子
documentKeys	string[]	リセットするドキュメントキー

応答

名前	型	説明
204 No Content		この要求に送信するコンテンツはありませんが、ヘッダーは役立つ場合があります。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchServiceResetDocs

要求のサンプル

HTTP

POST https://previewexampleservice.search.windows.net/indexers('myindexer')/search.resetdocs?api-version=2026-05-01-preview&overwrite=True


{
  "documentKeys": [
    "1",
    "2",
    "3"
  ]
}

応答のサンプル

状態コード:: 204

定義

名前	説明
Accept	Acceptヘッダーです。
DocumentKeysOrIds	キーの種類はOrIdsです。
ErrorAdditionalInfo	リソース管理エラーの追加情報
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=minimal

DocumentKeysOrIds

Object

キーの種類はOrIdsです。

名前	型	説明
datasourceDocumentIds	string[]	リセットするデータソース文書識別子
documentKeys	string[]	リセットするドキュメントキー

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーに関する追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーの対象。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。