インデクサーの更新 (Azure Cognitive 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 必須。 api-key は Search サービスに対する要求の認証に使用されます。 これはサービスに固有の文字列値です。 更新要求には、(クエリ キーではなく) 管理キーに設定されたヘッダーを含める api-key 必要があります。 API キーは、Azure portalの検索サービス ダッシュボードで見つけることができます。

要求本文

要求本文の構文は、 インデクサーの作成の構文と同じです。

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

応答

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

関連項目