Synonym Maps - Get

Hizmet:: Search Service

API Sürümü:: 2024-03-01-Preview

Eş anlamlı eşleme tanımını alır.

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2024-03-01-Preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Arama hizmetinin uç nokta URL'si.
synonymMapName	path	True	string	Alınacak eş anlamlı eşlemin adı.
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.

Yanıtlar

Name	Tür	Description
200 OK	SynonymMap
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchServiceGetSynonymMap

Örnek isteği

HTTP

GET https://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2024-03-01-Preview

Örnek yanıt

Durum kodu:: 200

{
  "name": "mysynonymmap",
  "format": "solr",
  "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
  "encryptionKey": {
    "keyVaultKeyName": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

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	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ı haritalar gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.
SynonymMap	Eş anlamlı eşleme tanımını temsil eder.
SynonymMapFormat	Eş anlamlı eşleminin 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'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.
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

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	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ı haritalar gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.

Name	Tür	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Azure Key Vault'unuza 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. Kaynağa güncelleştirildiğinde, açık kimlik belirtilmezse değişmeden kalır. "Hiçbiri" 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	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, Microsoft'un bile değil kimsenin verilerinizin şifresini çözemediğini tam olarak güvenceye almak istediğinizde verileriniz için bekleyen ek bir ş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 hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.
format	SynonymMapFormat	Eş anlamlı eşleminin biçimi. Şu anda yalnızca 'solr' biçimi desteklenmektedir.
name	string	Eş anlamlı eşlemesinin adı.
synonyms	string	Belirtilen eş anlamlı eşlem biçiminde bir dizi eş anlamlı kural. Kurallar yeni satırlarla ayrılmalıdır.

SynonymMapFormat

Numaralandırma

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

Değer	Description
solr	Eş anlamlı eşlemeleri için SOLR biçimini seçer.