エイリアス操作 (プレビュー REST API)

  • [アーティクル]

: 2023-07-01-Preview に適用されます。 このバージョンはサポートされなくなりました。 新しいバージョンにすぐに アップグレードします。

大事な

2023-07-01-Preview (変更なし)。

2021-04-30-Preview によって API が追加されます。

Azure AI Search では、インデックスエイリアスは検索インデックスのセカンダリ名です。 検索インデックスにマップするエイリアスを作成し、それ以外の場合はインデックス名を参照する場所でエイリアス名を置き換えることができます。 これにより、アプリケーションが指しているインデックスを変更する必要がある場合に、柔軟性が向上します。 アプリケーション コード内のインデックス名への参照を更新する代わりに、エイリアスのマッピングを更新するだけです。

特定のエイリアス リソースに対する HTTP 要求 (POST、GET、PUT、DELETE) を使用して、Azure AI Search サービスでエイリアスを作成および管理できます。 エイリアスはサービス レベルのリソースであり、検索インデックスとは別に維持されます。 検索インデックスが作成されたら、その検索インデックスにマップするエイリアスを作成できます。

手記

エイリアスは、ドキュメント操作 使用するか、インデックス定義を取得および更新する場合にのみ使用できます。 エイリアスを使用してインデックスを削除することはできません。Analyze Text API では使用できません。また、インデクサーの targetIndexName として使用することはできません。

例

次の例は、既存の検索インデックスにマップされるエイリアスを作成する方法を示しています。

POST /aliases?api-version=2023-07-01-Preview
{   
  "name" : "my-alias",  
  "indexes" : ["my-index"]
}

関連項目