Synonym Maps - Get

Ссылка

Служба:: Search Service

Версия API:: 2024-05-01-preview

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

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2024-05-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://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2024-05-01-preview

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

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

Определения

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

AzureActiveDirectoryApplicationCredentials

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

Имя	Тип	Описание
applicationId	string	Идентификатор приложения AAD, которому предоставлены необходимые разрешения на доступ к Key Vault Azure, который будет использоваться при шифровании неактивных данных. Идентификатор приложения не следует путать с идентификатором объекта для приложения 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-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска.

SearchResourceEncryptionKey

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

Имя	Тип	Описание
accessCredentials	AzureActiveDirectoryApplicationCredentials	Необязательные учетные данные Azure Active Directory, используемые для доступа к Key Vault Azure. Не требуется, если вместо этого используется управляемое удостоверение.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано и свойство учетных данных доступа имеет значение NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, значение этого свойства очищается.
keyVaultKeyName	string	Имя ключа Key Vault Azure, который будет использоваться для шифрования неактивных данных.
keyVaultKeyVersion	string	Версия ключа Key Vault Azure, который будет использоваться для шифрования неактивных данных.
keyVaultUri	string	Универсальный код ресурса (URI) Key Vault 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	string	Выбирает формат SOLR для карт синонимов.

Поделиться через