Aliases - Create Or Update

Layanan:: Search Service

Versi API:: 2025-11-01-preview

Membuat alias pencarian baru atau memperbarui alias jika sudah ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
aliasName	path	True	string	Nama alias.
endpoint	path	True	string (uri)	URL titik akhir layanan pencarian.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Accept		Accept	Header Terima.
If-Match		string	Menentukan kondisi If-Match. Operasi akan dilakukan hanya jika ETag di server cocok dengan nilai ini.
If-None-Match		string	Menentukan kondisi If-None-Match. Operasi akan dilakukan hanya jika ETag di server tidak cocok dengan nilai ini.
Prefer	True	Prefer	Untuk permintaan HTTP PUT, menginstruksikan layanan untuk mengembalikan sumber daya yang dibuat/diperbarui setelah berhasil.
x-ms-client-request-id		string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
indexes	True	string[]	Nama indeks yang dipetakan alias ini. Hanya satu nama indeks yang dapat ditentukan.
name	True	string	Nama alias.
@odata.etag		string	ETag dari alias.

Respons

Nama	Jenis	Deskripsi
200 OK	SearchAlias	Permintaan telah berhasil.
201 Created	SearchAlias	Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://search.azure.com/.default

Contoh

SearchServiceCreateOrUpdateAlias

Permintaan sampel

HTTP

PUT https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2025-11-01-preview





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

Respon sampel

Kode status:: 200

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

Kode status:: 201

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

Definisi

Nama	Deskripsi
Accept	Header Terima.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
Prefer	Untuk permintaan HTTP PUT, menginstruksikan layanan untuk mengembalikan sumber daya yang dibuat/diperbarui setelah berhasil.
SearchAlias	Mewakili alias indeks, yang menjelaskan pemetaan dari nama alias ke indeks. Nama alias dapat digunakan sebagai pengganti nama indeks untuk operasi yang didukung.

Accept

Enumerasi

Header Terima.

Nilai	Deskripsi
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

Prefer

Enumerasi

Untuk permintaan HTTP PUT, menginstruksikan layanan untuk mengembalikan sumber daya yang dibuat/diperbarui setelah berhasil.

Nilai	Deskripsi
return=representation

SearchAlias

Objek

Mewakili alias indeks, yang menjelaskan pemetaan dari nama alias ke indeks. Nama alias dapat digunakan sebagai pengganti nama indeks untuk operasi yang didukung.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag dari alias.
indexes	string[]	Nama indeks yang dipetakan alias ini. Hanya satu nama indeks yang dapat ditentukan.
name	string	Nama alias.