Synonym Maps - Create

Ссылка

Служба:: Search Service

Версия API:: 2024-07-01

Создает новую карту синонимов.

POST {endpoint}/synonymmaps?api-version=2024-07-01

Параметры URI

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

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

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

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

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

Ответы

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

Примеры

SearchServiceCreateSynonymMap

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

HTTP

POST https://myservice.search.windows.net/synonymmaps?api-version=2024-07-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": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "myApplicationSecret"
    }
  }
}

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

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

Определения

Имя	Описание
AzureActiveDirectoryApplicationCredentials	Учетные данные зарегистрированного приложения, созданного для службы поиска, используемого для проверки подлинности доступа к ключам шифрования, хранящимся в Azure Key Vault.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
SearchResourceEncryptionKey	Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые создаются и управляются, можно использовать для шифрования или расшифровки неактивных данных, таких как индексы и карты синонимов.
SynonymMap	Представляет определение карты синонимов.
SynonymMapFormat	Формат карты синонимов. В настоящее время поддерживается только формат 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	Объект ошибки.

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	string	Выбирает формат SOLR для карт синонимов.

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