インデクサーの更新 (Azure AI Search REST API)

  • [アーティクル]

HTTP PUT 要求を使用して、既存のインデクサー定義を更新できます。 要求 URI で更新するインデクサーの名前を指定します。

PUT https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]  
    Content-Type: application/json  
    api-key: [admin key]

インデクサー定義を更新しても自動的には実行されませんが、変更と関連するデータ ソースによっては、リセットと再実行が必要になる場合があります。

URI パラメーター

パラメーター 説明
サービス名 必須。 これを検索サービスの一意のユーザー定義名に設定します。
インデクサー名 必須。 要求 URI は、更新するインデクサーの名前を指定します。
api-version 必須。 現在の安定バージョンは です api-version=2020-06-30。 その他 のバージョンについては、「API のバージョン 」を参照してください。

要求ヘッダー

次の表では、必須と省略可能の要求ヘッダーについて説明します。

フィールド 説明
Content-Type 必須。 これを application/json
api-key Azure ロールを使用していて、要求でベアラー トークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。 更新要求には、(クエリ キーではなく) 管理者キーに設定されたヘッダーを含める api-key 必要があります。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。

要求本文

要求本文の構文は、 Create Indexer の場合と同じです。

既存のインデクサーを更新すると、定義全体が要求本文の内容に置き換えられます。 一般に、更新に使用する最適なパターンは、GET を使用してインデクサー定義を取得し、それを変更してから PUT で更新することです。

Response

要求成功の場合: 新しいインデクサーが作成された場合は「201 作成されました」で、既存のインデクサーが更新された場合は「204 コンテンツがありません」。

関連項目