Synonym Maps - List

Служба:: Search Service

Версия API:: 2023-11-01

Перечисляет все карты синонимов, доступные для службы поиска.

GET {endpoint}/synonymmaps?api-version=2023-11-01

С использованием необязательных параметров:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2023-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	URL-адрес конечной точки службы поиска.
api-version	query	True	string	Версия клиентского API.
$select	query		string	Выбирает свойства верхнего уровня для получения синонимов. Указан как разделенный запятыми список имен свойств JSON или `*` для всех свойств. Значение по умолчанию — все свойства.

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

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

Ответы

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

Примеры

SearchServiceListSynonymMaps

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

HTTP

GET https://myservice.search.windows.net/synonymmaps?api-version=2023-11-01

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

Код состояния:: 200

{
  "value": [
    {
      "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": null
      }
    },
    {
      "name": "myothersynonymmap",
      "format": "solr",
      "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat",
      "encryptionKey": null
    }
  ]
}

Определения

Имя	Описание
AzureActiveDirectoryApplicationCredentials	Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для проверки подлинности доступа к ключам шифрования, хранящимся в Azure Key Vault.
ListSynonymMapsResult	Ответ из запроса List SynonymMaps. При успешном выполнении он включает полные определения всех карт синонимов.
SearchError	Описывает условие ошибки для API.
SearchResourceEncryptionKey	Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые создаются и управляются, можно использовать для шифрования или расшифровки неактивных данных в службе поиска, таких как индексы и карты синонимов.
SynonymMap	Представляет определение карты синонимов.
SynonymMapFormat	Формат карты синонимов. В настоящее время поддерживается только формат solr.

AzureActiveDirectoryApplicationCredentials

Объект

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

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

ListSynonymMapsResult

Объект

Ответ из запроса List SynonymMaps. При успешном выполнении он включает полные определения всех карт синонимов.

Имя	Тип	Описание
value	SynonymMap[]	Синонимы сопоставляется в службе поиска.

SearchError

Объект

Описывает условие ошибки для API.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	SearchError[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
message	string	Читаемое пользователем представление ошибки.

SearchResourceEncryptionKey

Объект

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

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

SynonymMap

Объект

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

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

SynonymMapFormat

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

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

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