Synonym Maps - Create Or Update

Hizmet:: Search Service

API Sürümü:: 2026-08-01-preview

Yeni bir eş anlamlı eşleme oluşturur veya zaten varsa bir eş anlamlı eşlemeyi günceller.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Arama hizmetinin uç nokta URL'si.
synonymMapName	path	True	string	Eş anlamlı eşlemesinin adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Accept		Accept	Kabul Et başlığı.
If-Match		string	If-Match koşulunu tanımlar. İşlem yalnızca sunucudaki ETag bu değerle eşleşirse gerçekleştirilir.
If-None-Match		string	If-None-Match koşulunu tanımlar. İşlem yalnızca sunucudaki ETag bu değerle eşleşmiyorsa gerçekleştirilir.
Prefer	True	Prefer	HTTP PUT istekleri için, hizmete başarılı olduğunda oluşturulan/güncelleştirilen kaynağı döndürmesini söyler.
x-ms-client-request-id		string (uuid)	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Gövdesi

Name	Gerekli	Tür	Description
format	True	enum: solr	Eşanlamlı eşlemenin biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.
name	True	string	Eş anlamlı eşlemesinin adı.
synonyms	True	string	Belirtilen eşanlamlı eşleme biçiminde bir dizi eşanlamlı kural. Kurallar yeni satırlarla ayrılmalıdır.
@odata.etag		string	Eş anlamlı haritasının ETag'i.
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, kimsenin, hatta Microsoft'un bile verilerinizi şifreleyemeyeceğine tam güvence vermek istediğinizde, verileriniz için ek bir şifreleme seviyesi 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 hizmetlerinde 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
200 OK	SynonymMap	İstek başarılı oldu.
201 Created	SynonymMap	İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

api-key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name	Description
https://search.azure.com/.default

Örnekler

SearchServiceCreateOrUpdateSynonymMap

Örnek isteği

HTTP

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






{
  "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>"
    }
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

Örnek yanıt

Durum kodu:: 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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Durum kodu:: 201

{
  "@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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Tanımlar

Name	Description
Accept	Kabul Et başlığı.
ErrorAdditionalInfo	Kaynak yönetimi hatasına ilişkin ek bilgiler.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).
Prefer	HTTP PUT istekleri için, hizmete başarılı olduğunda oluşturulan/güncelleştirilen kaynağı döndürmesini söyler.
SearchIndexerDataNoneIdentity	Veri kaynağının kimlik özelliğini temizler.
SearchIndexerDataUserAssignedIdentity	Kullanılacak veri kaynağının kimliğini belirtir.
SearchResourceEncryptionKey	Azure Key Vault'ta müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.
SynonymMap	Eş anlamlı eşleme tanımını temsil eder.

Accept

Numaralandırma

Kabul Et başlığı.

Değer	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatasına ilişkin ek bilgiler.

Name	Tür	Description
info		Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgisi.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

Prefer

Numaralandırma

HTTP PUT istekleri için, hizmete başarılı olduğunda oluşturulan/güncelleştirilen kaynağı döndürmesini söyler.

Değer	Description
return=representation

SearchIndexerDataNoneIdentity

Nesne

Veri kaynağının kimlik özelliğini temizler.

Name	Tür	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Kimlik türünü belirten bir URI parçası.

SearchIndexerDataUserAssignedIdentity

Nesne

Kullanılacak veri kaynağının kimliğini belirtir.

Name	Tür	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Kimlik türünü belirten bir URI parçası.
federatedIdentityClientId	string	Çok kiracılı User-Assigned Yönetilen Kimlik Desteği: Kullanıcı tarafından atanan yönetilen kimlik ile federasyon yapacak şekilde yapılandırılmış çoklu uygulamanın istemci kimliği.
userAssignedIdentity	string	Kullanıcı tarafından atanan yönetilen kimliğin tam Azure kaynak kimliği genellikle arama hizmetine atanması gereken "/subscriptions/12345678-1234-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" biçimindedir.

SearchResourceEncryptionKey

Nesne

Azure Key Vault'ta müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.

Name	Tür	Default value	Description
accessCredentials.applicationId	string		Bekleyen verilerinizi şifrelerken kullanılacak Azure Key Vault'a gerekli erişim izinleri verilmiş bir AAD Uygulama Kimliği. Uygulama Kimliği, AAD Uygulamanızın Nesne Kimliği ile karıştırılmamalıdır.
accessCredentials.applicationSecret	string		Belirtilen AAD uygulamasının kimlik doğrulama anahtarı.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Bu şifreleme anahtarı için kullanılacak açık bir yönetilen kimlik. Belirtilmezse ve erişim kimlik bilgileri özelliği null ise, sistem tarafından atanan yönetilen kimlik kullanılır. Kaynağa güncelleştirildiğinde, açık kimlik belirtilmezse değişmeden kalır. "Hiçbiri" belirtilirse, bu özelliğin değeri temizlenir.
isServiceLevelKey	boolean	False	Bu anahtarın hizmet seviyesi anahtar olup olmadığını gösteren isteğe bağlı bir değer. Varsayılan değer false'tur.
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'sidir. Örnek bir URI `https://my-keyvault-name.vault.azure.net`olabilir.

SynonymMap

Nesne

Eş anlamlı eşleme tanımını temsil eder.

Name	Tür	Description
@odata.etag	string	Eş anlamlı haritasının ETag'i.
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, kimsenin, hatta Microsoft'un bile verilerinizi şifreleyemeyeceğine tam güvence vermek istediğinizde, verileriniz için ek bir şifreleme seviyesi 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 hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.
format	enum: solr	Eşanlamlı eşlemenin biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.
name	string	Eş anlamlı eşlemesinin adı.
synonyms	string	Belirtilen eşanlamlı eşleme biçiminde bir dizi eşanlamlı kural. Kurallar yeni satırlarla ayrılmalıdır.