Synonym Maps - Create
Yeni bir eş anlamlı eşlem oluşturur.
POST {endpoint}/synonymmaps?api-version=2023-11-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Arama hizmetinin uç nokta URL'si. |
api-version
|
query | True |
string |
İstemci Api Sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Hata ayıklamaya yardımcı olmak için istekle birlikte gönderilen izleme kimliği. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
format | True |
Eş anlamlı eşlem biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir. |
|
name | True |
string |
Eş anlamlı eşlem adı. |
synonyms | True |
string |
Belirtilen eş anlamlı eşlem biçiminde bir dizi eş anlamlı kural. Kurallar yeni satırlarla ayrılmalıdır. |
@odata.etag |
string |
Eş anlamlı haritanın ETag'i. |
|
encryptionKey |
Azure Key Vault'de oluşturduğunuz şifreleme anahtarının açıklaması. Bu anahtar, hassas verilerinizin şifresini microsoft bile olmayan hiç kimsenin çözemediğini tam olarak güvenceye almak istediğinizde verileriniz için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Verilerinizi şifreledikten sonra her zaman şifrelenmiş olarak kalır. Arama hizmeti bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Verileriniz etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
Yanıtlar
Name | Tür | Description |
---|---|---|
201 Created | ||
Other Status Codes |
Hata yanıtı. |
Örnekler
SearchServiceCreateSynonymMap
Örnek isteği
POST https://myservice.search.windows.net/synonymmaps?api-version=2023-11-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"
}
}
}
Örnek yanıt
{
"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
}
}
}
Tanımlar
Name | Description |
---|---|
Azure |
Arama hizmetiniz için oluşturulan ve Azure Key Vault depolanan şifreleme anahtarlarına kimliği doğrulanmış erişim için kullanılan kayıtlı bir uygulamanın kimlik bilgileri. |
Search |
API için bir hata koşulu açıklar. |
Search |
Azure Key Vault'da müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi arama hizmetinizdeki bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir. |
Synonym |
Eş anlamlı eşlem tanımını temsil eder. |
Synonym |
Eş anlamlı eşlem biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir. |
AzureActiveDirectoryApplicationCredentials
Arama hizmetiniz için oluşturulan ve Azure Key Vault depolanan şifreleme anahtarlarına kimliği doğrulanmış erişim için kullanılan kayıtlı bir uygulamanın kimlik bilgileri.
Name | Tür | Description |
---|---|---|
applicationId |
string |
Bekleyen verilerinizi şifrelerken kullanılacak Azure Key Vault gerekli erişim izinlerine sahip bir AAD Uygulama Kimliği. Uygulama Kimliği, AAD Uygulamanızın Nesne Kimliği ile karıştırılmamalıdır. |
applicationSecret |
string |
Belirtilen AAD uygulamasının kimlik doğrulama anahtarı. |
SearchError
API için bir hata koşulu açıklar.
Name | Tür | Description |
---|---|---|
code |
string |
Sunucu tanımlı hata kodları kümesinden biri. |
details |
Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı. |
|
message |
string |
Hatanın insanlar tarafından okunabilir bir gösterimi. |
SearchResourceEncryptionKey
Azure Key Vault'da müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi arama hizmetinizdeki bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.
Name | Tür | Description |
---|---|---|
accessCredentials |
Azure Key Vault erişmek için kullanılan isteğe bağlı Azure Active Directory kimlik bilgileri. Bunun yerine yönetilen kimlik kullanılıyorsa gerekli değildir. |
|
keyVaultKeyName |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak Azure Key Vault anahtarınızın adı. |
keyVaultKeyVersion |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak Azure Key Vault anahtarınızın sürümü. |
keyVaultUri |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak anahtarı içeren DNS adı olarak da adlandırılan Azure Key Vault URI'niz. Örnek bir URI olabilir |
SynonymMap
Eş anlamlı eşlem tanımını temsil eder.
Name | Tür | Description |
---|---|---|
@odata.etag |
string |
Eş anlamlı haritanın ETag'i. |
encryptionKey |
Azure Key Vault'de oluşturduğunuz şifreleme anahtarının açıklaması. Bu anahtar, hassas verilerinizin şifresini microsoft bile olmayan hiç kimsenin çözemediğini tam olarak güvenceye almak istediğinizde verileriniz için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Verilerinizi şifreledikten sonra her zaman şifrelenmiş olarak kalır. Arama hizmeti bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Verileriniz etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
format |
Eş anlamlı eşlem biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir. |
|
name |
string |
Eş anlamlı eşlem adı. |
synonyms |
string |
Belirtilen eş anlamlı eşlem biçiminde bir dizi eş anlamlı kural. Kurallar yeni satırlarla ayrılmalıdır. |
SynonymMapFormat
Eş anlamlı eşlem biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.
Name | Tür | Description |
---|---|---|
solr |
string |
Eş anlamlı eşlemeler için SOLR biçimini seçer. |