エイリアス操作 (プレビュー REST API)
適用対象: 2023-07-01-Preview、2021-04-30-Preview
重要
2023-07-01-Preview (変更なし)。
2021-04-30-Preview によって API が追加されます。
Azure AI Search では、インデックスエイリアスは検索インデックスのセカンダリ名です。 検索インデックスに対応する別名を作成しておけば、インデックス名を別の方法で参照するような場面で、その別名を代わりに使用できます。 これにより、アプリケーションが指しているインデックスを変更する必要がある場合に、柔軟性が向上します。 アプリケーション コード内のインデックス名への参照を更新する代わりに、エイリアスのマッピングを更新するだけです。
特定のエイリアス リソースに対する HTTP 要求 (POST、GET、PUT、DELETE) を使用して、Azure AI Search Serviceでエイリアスを作成および管理できます。 エイリアスはサービス レベルのリソースであり、検索インデックスとは無関係に維持されます。 検索インデックスが作成されたら、その検索インデックスにマップされるエイリアスを作成できます。
注意
別名は、ドキュメントの操作でのみ使用するか、インデックス定義を取得および更新する場合にのみ使用することができます。 別名をインデックスの削除に使用したり、Analyze Text API で使用したりすることはできず、またインデクサーで targetIndexName として使用することもできません。
例
次の例は、既存の検索インデックスにマップされるエイリアスを作成する方法を示しています。
POST /aliases?api-version=2023-07-01-Preview
{
"name" : "my-alias",
"indexes" : ["my-index"]
}