Synonym Maps - Create

Hizmet:: Search Service

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

Yeni bir eş anlamlı eşleme oluşturur.

POST {endpoint}/synonymmaps?api-version=2025-08-01-preview

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	SynonymMapFormat	Eşanlamlı eşlemenin biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.
name	True	string	Eşanlamlı eşlemenin 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ı haritanın ETag'i.
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, hiç kimsenin, hatta Microsoft'un bile verilerinizin şifresini çözemeyeceğinden tam olarak emin olmak istediğinizde, verileriniz için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Verilerinizi bir kez şifreledikten sonra, her zaman şifreli kalacaktı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 etkilenmeyecektir. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019'da veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.

Yanıtlar

Name	Tür	Description
201 Created	SynonymMap
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchServiceCreateSynonymMap

Örnek isteği

HTTP

POST https://previewexampleservice.search.windows.net/synonymmaps?api-version=2025-08-01-preview


{
  "name": "tempsynonymmap",
  "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:: 201

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

Tanımlar

Name	Description
AzureActiveDirectoryApplicationCredentials	Arama hizmetiniz için oluşturulan ve Azure Key Vault'ta depolanan şifreleme anahtarlarına kimliği doğrulanmış erişim için kullanılan kayıtlı bir uygulamanın kimlik bilgileri.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
SearchIndexerDataNoneIdentity	Bir 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ı bir eşleme tanımını temsil eder.
SynonymMapFormat	Eşanlamlı eşlemenin biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.

AzureActiveDirectoryApplicationCredentials

Nesne

Arama hizmetiniz için oluşturulan ve Azure Key Vault'ta 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 için 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.
applicationSecret	string	Belirtilen AAD uygulamasının kimlik doğrulama anahtarı.

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

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

ErrorDetail

Nesne

Hata ayrıntısı.

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

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

SearchIndexerDataNoneIdentity

Nesne

Bir 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ı.
userAssignedIdentity	string	Genellikle "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" biçiminde yönetilen kimlik atanan bir kullanıcının tam Azure kaynak kimliği.

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	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	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.
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. Kaynak güncelleştirildiğinde, açık kimlik belirtilmemişse değişmeden kalır. "None" belirtilirse, bu özelliğin değeri temizlenir.
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	DNS adı olarak da adlandırılan Azure Key Vault URI'si, bekleyen verilerinizi şifrelemek için kullanılacak anahtarı içerir. Örnek bir URI olabilir `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Nesne

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

Name	Tür	Description
@odata.etag	string	Eşanlamlı haritanın ETag'i.
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, hiç kimsenin, hatta Microsoft'un bile verilerinizin şifresini çözemeyeceğinden tam olarak emin olmak istediğinizde, verileriniz için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Verilerinizi bir kez şifreledikten sonra, her zaman şifreli kalacaktı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 etkilenmeyecektir. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019'da veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.
format	SynonymMapFormat	Eşanlamlı eşlemenin biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.
name	string	Eşanlamlı eşlemenin adı.
synonyms	string	Belirtilen eşanlamlı eşleme biçiminde bir dizi eşanlamlı kural. Kurallar yeni satırlarla ayrılmalıdır.

SynonymMapFormat

Numaralandırma

Eşanlamlı eşlemenin biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.

Değer	Description
solr	Eş anlamlı eşlemeler için SOLR formatını seçer.