通过

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

Synonym Maps - Create

服务:
Search Service
API 版本:
2025-09-01

创建新的同义词映射。

POST {endpoint}/synonymmaps?api-version=2025-09-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

ErrorResponse

错误响应。

示例

SearchServiceCreateSynonymMap

示例请求

POST https://stableexampleservice.search.windows.net/synonymmaps?api-version=2025-09-01


{
  "name": "tempsynonymmap",
  "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>"
    }
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

示例响应

状态代码:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempsynonymmap",
  "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>"
    }
  }
}

定义

名称 说明
AzureActiveDirectoryApplicationCredentials

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

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
SearchResourceEncryptionKey

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

表示同义词映射定义。
SynonymMapFormat

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

AzureActiveDirectoryApplicationCredentials

Object

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

名称 类型 说明
applicationId

string

向 Azure Key Vault 授予所需的访问权限的 AAD 应用程序 ID，该权限将在加密静态数据时使用。 应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
applicationSecret

string

指定 AAD 应用程序的身份验证密钥。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

SearchResourceEncryptionKey

Object

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

名称 类型 说明
accessCredentials

AzureActiveDirectoryApplicationCredentials

用于访问 Azure Key Vault 的可选 Azure Active Directory 凭据。 如果改用托管标识，则不需要。
keyVaultKeyName

string

用于加密静态数据的 Azure Key Vault 密钥的名称。
keyVaultKeyVersion

string

用于加密静态数据的 Azure Key Vault 密钥版本。
keyVaultUri

string

Azure 密钥保管库的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。 一个示例 URI 可能是 https://my-keyvault-name.vault.azure.net。

SynonymMap

Object

表示同义词映射定义。

名称 类型 说明
@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 格式。