Aliases - Create Or Update

サービス:: Search Service

API バージョン:: 2026-08-01-preview

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

PUT {endpoint}/aliases('{aliasName}')?api-version=2026-08-01-preview

URI パラメーター

名前	/	必須	型	説明
aliasName	path	True	string	エイリアスの名前。
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
If-Match		string	If-Match 条件を定義します。この操作は、サーバー上の ETag がこの値に一致する場合にのみ実行されます。
If-None-Match		string	If-None-Match 条件を定義します。この操作は、サーバー上の ETag がこの値と一致しない場合にのみ実行されます。
Prefer	True	Prefer	HTTP PUT 要求の場合、成功時に作成/更新されたリソースを返すようにサービスに指示します。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前	必須	型	説明
indexes	True	string[]	このエイリアスがマップされるインデックスの名前。指定できるインデックス名は 1 つだけです。
name	True	string	エイリアスの名前。
@odata.etag		string	エイリアスの ETag。

応答

名前	型	説明
200 OK	SearchAlias	要求は成功しました。
201 Created	SearchAlias	要求が成功し、結果として新しいリソースが作成されました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchServiceCreateOrUpdateAlias

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/aliases('myalias')?api-version=2026-08-01-preview






{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ],
  "@odata.etag": "0x1234568AE7E58A1"
}

応答のサンプル

状態コード:: 200

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

状態コード:: 201

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

定義

名前	説明
Accept	Acceptヘッダーです。
ErrorAdditionalInfo	リソース管理エラーの追加情報
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
Prefer	HTTP PUT 要求の場合、成功時に作成/更新されたリソースを返すようにサービスに指示します。
SearchAlias	エイリアス名からインデックスへのマッピングを表すインデックスエイリアスを表します。エイリアス名は、サポートされている操作のインデックス名の代わりに使用できます。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

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

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーに関する追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーの対象。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

Prefer

列挙

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

値	説明
return=representation

SearchAlias

Object

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

名前	型	説明
@odata.etag	string	エイリアスの ETag。
indexes	string[]	このエイリアスがマップされるインデックスの名前。指定できるインデックス名は 1 つだけです。
name	string	エイリアスの名前。