Aliases - Create Or Update

サービス:
Search Service
API バージョン:
2024-03-01-Preview

新しい検索エイリアスを作成するか、エイリアスが既に存在する場合は更新します。

PUT {endpoint}/aliases('{aliasName}')?api-version=2024-03-01-Preview

URI パラメーター

名前 / 必須 型 説明
aliasName
 path True

string

作成または更新するエイリアスの定義。
endpoint
 path True

string

検索サービスのエンドポイント URL。
api-version
 query True

string

クライアント API のバージョン。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string (uuid)

デバッグに役立つ要求と共に送信される追跡 ID。
If-Match

string

If-Match 条件を定義します。 この操作は、サーバー上の ETag がこの値と一致する場合にのみ実行されます。
If-None-Match

string

If-None-Match 条件を定義します。 この操作は、サーバー上の ETag がこの値と一致しない場合にのみ実行されます。
Prefer True

string

HTTP PUT 要求の場合は、正常に作成/更新されたリソースを返すようにサービスに指示します。

要求本文

名前 必須 型 説明
indexes True

string[]

このエイリアスがマップされるインデックスの名前。 指定できるインデックス名は 1 つだけです。
name True

string

エイリアスの名前。
@odata.etag

string

エイリアスの ETag。

応答

名前 型 説明
200 OK

SearchAlias

201 Created

SearchAlias

Other Status Codes

ErrorResponse

エラー応答。

例

SearchServiceCreateOrUpdateAlias

要求のサンプル

PUT https://myservice.search.windows.net/aliases('production')?api-version=2024-03-01-Preview


{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

応答のサンプル

状態コード:
200 
{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}
状態コード:
201 
{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

定義

名前 説明
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
SearchAlias

エイリアス名からインデックスへのマッピングを表すインデックス エイリアスを表します。 エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。

ErrorAdditionalInfo

Object

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

SearchAlias

Object

エイリアス名からインデックスへのマッピングを表すインデックス エイリアスを表します。 エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。

名前 型 説明
@odata.etag

string

エイリアスの ETag。
indexes

string[]

このエイリアスがマップされるインデックスの名前。 指定できるインデックス名は 1 つだけです。
name

string

エイリアスの名前。