Synonym Maps - Get

Служба:: Search Service

Версия API:: 2026-04-01

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

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2026-04-01

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	SynonymMap	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchServiceGetSynonymMap

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

HTTP

GET https://exampleservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2026-04-01

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

Код состояния:: 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>"
    }
  }
}

Определения

Имя	Описание
Accept	Заголовок Accept.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
SearchIndexerDataNoneIdentity	Очищает свойство удостоверения источника данных.
SearchIndexerDataUserAssignedIdentity	Указывает удостоверение для используемого источника данных.
SearchResourceEncryptionKey	Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов.
SynonymMap	Представляет определение карты синонимов.

Accept

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

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

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

SearchIndexerDataNoneIdentity

Объект

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

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

SearchIndexerDataUserAssignedIdentity

Объект

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

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

SearchResourceEncryptionKey

Объект

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

Имя	Тип	Описание
accessCredentials.applicationId	string	Идентификатор приложения AAD, которому было предоставлено необходимые разрешения на доступ к Azure Key Vault, который будет использоваться при шифровании неактивных данных. Идентификатор приложения не следует путать с идентификатором объекта для приложения AAD.
accessCredentials.applicationSecret	string	Ключ проверки подлинности указанного приложения AAD.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано, а свойство учетных данных доступа равно NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, то значение этого свойства очищается.
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. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для ваших данных, когда вы хотите быть полностью уверены, что никто, даже Microsoft, не сможет расшифровать ваши данные. После шифрования данных он всегда будет оставаться зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Это свойство можно изменить по мере необходимости, если вы хотите повернуть ключ шифрования; Ваши данные не будут затронуты. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
format	enum: solr	Формат синонима map. В настоящее время поддерживается только формат 'solr'.
name	string	Имя карты синонимов.
synonyms	string	Ряд правил синонимов в указанном формате карты синонимов. Правила должны быть разделены переводом строк.