你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Synonym Maps - Create

服务:: Search Service

API 版本:: 2023-11-01

创建新的同义词映射。

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	搜索服务的终结点 URL。
api-version	query	True	string	客户端 API 版本。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	随请求一起发送的跟踪 ID，以帮助进行调试。

请求正文

名称	必需	类型	说明
format	True	SynonymMapFormat	同义词映射的格式。目前仅支持“solr”格式。
name	True	string	同义词映射的名称。
synonyms	True	string	指定同义词映射格式的一系列同义词规则。规则必须用换行符分隔。
@odata.etag		string	同义词映射的 ETag。
encryptionKey		SearchResourceEncryptionKey	描述在 Azure Key Vault 中创建的加密密钥。当你希望完全保证没有人（甚至Microsoft）可以解密敏感数据时，此密钥用于为数据提供额外的静态加密级别。加密数据后，数据将始终保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果需要轮换加密密钥，可以根据需要更改此属性;你的数据将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。

响应

名称	类型	说明
201 Created	SynonymMap
Other Status Codes	SearchError	错误响应。

示例

SearchServiceCreateSynonymMap

示例请求

HTTP

POST https://myservice.search.windows.net/synonymmaps?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": {
      "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 中存储的加密密钥进行身份验证的访问权限。
SearchError	描述 API 的错误条件。
SearchResourceEncryptionKey	Azure Key Vault 中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密搜索服务上的静态数据，例如索引和同义词映射。
SynonymMap	表示同义词映射定义。
SynonymMapFormat	同义词映射的格式。目前仅支持“solr”格式。

AzureActiveDirectoryApplicationCredentials

对象

为搜索服务创建的已注册应用程序的凭据，用于对 Azure Key Vault 中存储的加密密钥进行身份验证的访问权限。

名称	类型	说明
applicationId	string	向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure Key Vault 所需的访问权限。应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
applicationSecret	string	指定的 AAD 应用程序的身份验证密钥。

SearchError

对象

描述 API 的错误条件。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	SearchError[]	导致此报告错误的特定错误的详细信息数组。
message	string	错误的人工可读表示形式。

SearchResourceEncryptionKey

对象

Azure Key Vault 中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密搜索服务上的静态数据，例如索引和同义词映射。

名称	类型	说明
accessCredentials	AzureActiveDirectoryApplicationCredentials	用于访问 Azure Key Vault 的可选 Azure Active Directory 凭据。如果改用托管标识，则不需要。
keyVaultKeyName	string	用于加密静态数据的 Azure Key Vault 密钥的名称。
keyVaultKeyVersion	string	用于加密静态数据的 Azure Key Vault 密钥的版本。
keyVaultUri	string	Azure Key Vault 的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。示例 URI 可能是 `https://my-keyvault-name.vault.azure.net`。

SynonymMap

对象

表示同义词映射定义。

名称	类型	说明
@odata.etag	string	同义词映射的 ETag。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure Key Vault 中创建的加密密钥。当你希望完全保证没有人（甚至Microsoft）可以解密敏感数据时，此密钥用于为数据提供额外的静态加密级别。加密数据后，数据将始终保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果需要轮换加密密钥，可以根据需要更改此属性;你的数据将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
format	SynonymMapFormat	同义词映射的格式。目前仅支持“solr”格式。
name	string	同义词映射的名称。
synonyms	string	指定同义词映射格式的一系列同义词规则。规则必须用换行符分隔。

SynonymMapFormat

枚举

同义词映射的格式。目前仅支持“solr”格式。

值	说明
solr	为同义词映射选择 SOLR 格式。