Synonym Maps - Get

Служба:: Search Service

Версия API:: 2025-08-01-preview

Извлекает определение карты синонимов.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
synonymMapName	path	True	string	Имя карты синонимов для извлечения.
api-version	query	True	string	Версия API клиента.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string (uuid)	Идентификатор отслеживания, отправленный вместе с запросом на помощь в отладке.

Ответы

Имя	Тип	Описание
200 OK	SynonymMap
Other Status Codes	ErrorResponse	Ответ на ошибку.

Примеры

SearchServiceGetSynonymMap

Образец запроса

HTTP

GET https://previewexampleservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2025-08-01-preview

Пример ответа

Код состояния:: 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",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Определения

Имя	Описание
AzureActiveDirectoryApplicationCredentials	Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для доступа с проверкой подлинности к ключам шифрования, хранящимся в Azure Key Vault.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
SearchIndexerDataNoneIdentity	Очищает свойство identity источника данных.
SearchIndexerDataUserAssignedIdentity	Указывает идентификатор для используемого источника данных.
SearchResourceEncryptionKey	Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов.
SynonymMap	Представляет собой определение карты синонимов.
SynonymMapFormat	Формат синонима map. В настоящее время поддерживается только формат 'solr'.

AzureActiveDirectoryApplicationCredentials

Объект

Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для доступа с проверкой подлинности к ключам шифрования, хранящимся в Azure Key Vault.

Имя	Тип	Описание
applicationId	string	Идентификатор приложения AAD, которому предоставлены необходимые разрешения на доступ к Azure Key Vault, который будет использоваться при шифровании неактивных данных. Идентификатор приложения не следует путать с идентификатором объекта для приложения AAD.
applicationSecret	string	Ключ аутентификации указанного приложения AAD.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

SearchIndexerDataNoneIdentity

Объект

Очищает свойство identity источника данных.

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Фрагмент URI, указывающий тип удостоверения.

SearchIndexerDataUserAssignedIdentity

Объект

Указывает идентификатор для используемого источника данных.

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Фрагмент URI, указывающий тип удостоверения.
userAssignedIdentity	string	Полный идентификатор ресурса Azure управляемого удостоверения, назначенного пользователем, обычно в форме "/subscriptions/12345678-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска.

SearchResourceEncryptionKey

Объект

Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов.

Имя	Тип	Описание
accessCredentials	AzureActiveDirectoryApplicationCredentials	Необязательные учетные данные Azure Active Directory, используемые для доступа к Azure Key Vault. Не требуется, если вместо этого используется управляемое удостоверение.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение, используемое для этого ключа шифрования. Если значение не указано и свойство учетных данных для доступа равно null, используется управляемое удостоверение, назначенное системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если указано значение "none", значение этого свойства сбрасывается.
keyVaultKeyName	string	Имя ключа Azure Key Vault, который будет использоваться для шифрования неактивных данных.
keyVaultKeyVersion	string	Версия ключа Azure Key Vault, который будет использоваться для шифрования неактивных данных.
keyVaultUri	string	URI Azure Key Vault, также называемый DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Примером URI может быть .`https://my-keyvault-name.vault.azure.net`

SynonymMap

Объект

Представляет собой определение карты синонимов.

Имя	Тип	Описание
@odata.etag	string	ETag карты синонимов.
encryptionKey	SearchResourceEncryptionKey	Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для обеспечения дополнительного уровня шифрования данных при хранении, когда вы хотите быть уверены в том, что никто, даже корпорация Майкрософт, не сможет расшифровать ваши данные. После того, как вы зашифровали свои данные, они всегда останутся зашифрованными. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Ваши данные не будут затронуты. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных поисковых служб и доступно только для платных служб, созданных 1 января 2019 г. или позже.
format	SynonymMapFormat	Формат синонима map. В настоящее время поддерживается только формат 'solr'.
name	string	Название синонима map.
synonyms	string	Ряд правил синонимов в указанном формате карты синонимов. Правила должны быть разделены переводом строк.

SynonymMapFormat

Перечисление

Формат синонима map. В настоящее время поддерживается только формат 'solr'.

Значение	Описание
solr	Выбор формата SOLR для карт синонимов.