Synonym Maps - Get

Layanan:: Search Service

Versi API:: 2026-05-01-preview

Mengambil definisi peta sinonim.

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2026-05-01-preview

Parameter URI

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

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Accept		Accept	Header Terima.
x-ms-client-request-id		string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Respons

Nama	Jenis	Deskripsi
200 OK	SynonymMap	Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak 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

SearchServiceGetSynonymMap

Permintaan sampel

HTTP

GET https://previewexampleservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2026-05-01-preview

Respon sampel

Kode status:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "mysynonymmap",
  "format": "solr",
  "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definisi

Nama	Deskripsi
Accept	Header Terima.
ErrorAdditionalInfo	Informasi tambahan tentang kesalahan pengelolaan 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.).
SearchIndexerDataNoneIdentity	Menghapus properti identitas sumber data.
SearchIndexerDataUserAssignedIdentity	Menentukan identitas untuk sumber data yang akan digunakan.
SearchResourceEncryptionKey	Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data-at-rest, seperti indeks dan peta sinonim.
SynonymMap	Mewakili definisi peta sinonim.

Accept

Enumerasi

Header Terima.

Nilai	Deskripsi
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objek

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

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

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Informasi tambahan tentang kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran 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.

SearchIndexerDataNoneIdentity

Objek

Menghapus properti identitas sumber data.

Nama	Jenis	Deskripsi
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragmen URI yang menentukan jenis identitas.

SearchIndexerDataUserAssignedIdentity

Objek

Menentukan identitas untuk sumber data yang akan digunakan.

Nama	Jenis	Deskripsi
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragmen URI yang menentukan jenis identitas.
federatedIdentityClientId	string	Dukungan Identitas Terkelola User-Assigned Multi-penyewa: ID klien Aplikasi multi-tentant yang telah dikonfigurasi untuk berfederasi dengan identitas terkelola yang ditetapkan pengguna.
userAssignedIdentity	string	Id sumber daya Azure yang sepenuhnya memenuhi syarat dari identitas terkelola yang ditetapkan pengguna biasanya dalam formulir "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" yang seharusnya ditetapkan ke layanan pencarian.

SearchResourceEncryptionKey

Objek

Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data-at-rest, seperti indeks dan peta sinonim.

Nama	Jenis	Nilai default	Deskripsi
accessCredentials.applicationId	string		ID Aplikasi AAD yang diberikan izin akses yang diperlukan ke Azure Key Vault yang akan digunakan saat mengenkripsi data Anda tidak aktif. ID Aplikasi tidak boleh bingung dengan ID Objek untuk Aplikasi AAD Anda.
accessCredentials.applicationSecret	string		Kunci autentikasi aplikasi AAD yang ditentukan.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Identitas terkelola eksplisit yang digunakan untuk kunci enkripsi ini. Jika tidak ditentukan dan properti kredensial akses null, identitas terkelola yang ditetapkan sistem akan digunakan. Pada pembaruan ke sumber daya, jika identitas eksplisit tidak ditentukan, identitas tersebut tetap tidak berubah. Jika "tidak ada" ditentukan, nilai properti ini akan dihapus.
isServiceLevelKey	boolean	False	Nilai opsional yang menunjukkan apakah kunci ini adalah kunci tingkat layanan. Secara default adalah false.
keyVaultKeyName	string		Nama kunci Azure Key Vault Anda yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif.
keyVaultKeyVersion	string		Versi kunci Azure Key Vault Anda yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif.
keyVaultUri	string		URI Azure Key Vault Anda, juga disebut sebagai nama DNS, yang berisi kunci yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif. Contoh URI mungkin `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objek

Mewakili definisi peta sinonim.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag peta sinonim.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk data Anda saat Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsi data Anda. Setelah Anda mengenkripsi data Anda, data tersebut akan selalu tetap dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi; Data Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
format	enum: solr	Format peta sinonim. Hanya format 'solr' yang saat ini didukung.
name	string	Nama peta sinonim.
synonyms	string	Serangkaian aturan sinonim dalam format peta sinonim yang ditentukan. Aturan harus dipisahkan oleh baris baru.