Synonym Maps - Create Or Update

Ссылка

Служба:: Search Service

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

Создает новую карту синонимов или обновляет карту синонимов, если она уже существует.

PUT {endpoint}/synonymmaps('{synonymMapName}')?api-version=2023-11-01

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string uuid	Идентификатор отслеживания, отправленный с запросом для помощи в отладке.
If-Match		string	Определяет условие If-Match. Операция будет выполняться только в том случае, если ETag на сервере соответствует этому значению.
If-None-Match		string	Определяет условие If-None-Match. Операция будет выполняться только в том случае, если ETag на сервере не соответствует этому значению.
Prefer	True	string	Для HTTP-запросов PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении.

Текст запроса

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

Ответы

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

Примеры

SearchServiceCreateOrUpdateSynonymMap

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

HTTP

PUT https://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2023-11-01


{
  "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": null
  }
}

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

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

{
  "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": null
  }
}

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

{
  "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": null
  }
}

Определения

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

AzureActiveDirectoryApplicationCredentials

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

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

SearchError

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

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

SearchResourceEncryptionKey

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

Имя	Тип	Описание
accessCredentials	AzureActiveDirectoryApplicationCredentials	Необязательные учетные данные Azure Active Directory, используемые для доступа к Key Vault Azure. Не требуется, если вместо этого используется управляемое удостоверение.
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 для карт синонимов.

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