Synonym Maps - Create
Membuat peta sinonim baru.
POST {endpoint}/synonymmaps?api-version=2024-07-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
endpoint
|
path | True |
string |
URL titik akhir layanan pencarian. |
api-version
|
query | True |
string |
Versi Api Klien. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
x-ms-client-request-id |
string uuid |
ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
format | True |
Format peta sinonim. Hanya format 'solr' yang saat ini didukung. |
|
name | True |
string |
Nama peta sinonim. |
synonyms | True |
string |
Serangkaian aturan sinonim dalam format peta sinonim yang ditentukan. Aturan harus dipisahkan oleh baris baru. |
@odata.etag |
string |
ETag peta sinonim. |
|
encryptionKey |
Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk menyediakan tingkat enkripsi-tidak aktif tambahan untuk data Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada yang, bahkan Microsoft, 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. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
201 Created | ||
Other Status Codes |
Respons kesalahan. |
Contoh
SearchServiceCreateSynonymMap
Permintaan sampel
POST https://myservice.search.windows.net/synonymmaps?api-version=2024-07-01
{
"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": "myApplicationSecret"
}
}
}
Respon sampel
{
"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": null
}
}
}
Definisi
Nama | Deskripsi |
---|---|
Azure |
Kredensial aplikasi terdaftar yang dibuat untuk layanan pencarian Anda, digunakan untuk akses terautentikasi ke kunci enkripsi yang disimpan di Azure Key Vault. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Search |
Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data tidak aktif, seperti indeks dan peta sinonim. |
Synonym |
Mewakili definisi peta sinonim. |
Synonym |
Format peta sinonim. Hanya format 'solr' yang saat ini didukung. |
AzureActiveDirectoryApplicationCredentials
Kredensial aplikasi terdaftar yang dibuat untuk layanan pencarian Anda, digunakan untuk akses terautentikasi ke kunci enkripsi yang disimpan di Azure Key Vault.
Nama | Jenis | Deskripsi |
---|---|---|
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. |
applicationSecret |
string |
Kunci autentikasi aplikasi AAD yang ditentukan. |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorDetail
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |
SearchResourceEncryptionKey
Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data tidak aktif, seperti indeks dan peta sinonim.
Nama | Jenis | Deskripsi |
---|---|---|
accessCredentials |
Kredensial Azure Active Directory opsional yang digunakan untuk mengakses Azure Key Vault Anda. Tidak diperlukan jika menggunakan identitas terkelola sebagai gantinya. |
|
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 |
SynonymMap
Mewakili definisi peta sinonim.
Nama | Jenis | Deskripsi |
---|---|---|
@odata.etag |
string |
ETag peta sinonim. |
encryptionKey |
Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk menyediakan tingkat enkripsi-tidak aktif tambahan untuk data Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada yang, bahkan Microsoft, 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 |
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. |
SynonymMapFormat
Format peta sinonim. Hanya format 'solr' yang saat ini didukung.
Nama | Jenis | Deskripsi |
---|---|---|
solr |
string |
Memilih format SOLR untuk peta sinonim. |