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

Synonym Maps - List

服务:
Search Service
API 版本:
2026-04-01

列出可用于搜索服务的所有同义词映射。

GET {endpoint}/synonymmaps?api-version=2026-04-01
具有可选参数: 
GET {endpoint}/synonymmaps?api-version=2026-04-01&$select={$select}

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (uri)

搜索服务的终结点 URL。
api-version
 query True

string

minLength: 1

用于此操作的 API 版本。
$select
 query

string[]

选择要检索哪些顶级属性。 指定为以逗号分隔的 JSON 属性名称列表，或指定为“*”表示所有属性。 默认值为所有属性。

请求头

名称 必需 类型 说明
Accept

Accept

接受（Accept）首部。
x-ms-client-request-id

string (uuid)

请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称 类型 说明
200 OK

ListSynonymMapsResult

请求已成功。
Other Status Codes

ErrorResponse

意外的错误响应。

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称 说明
https://search.azure.com/.default

示例

SearchServiceListSynonymMaps

示例请求

GET https://exampleservice.search.windows.net/synonymmaps?api-version=2026-04-01&$select=

示例响应

状态代码:
200 
{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "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": "<applicationSecret>"
        }
      }
    }
  ]
}

定义

名称 说明
Accept

接受（Accept）首部。
ErrorAdditionalInfo

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

错误详细信息。
ErrorResponse

所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。 （这也遵循 OData 错误响应格式）。
ListSynonymMapsResult

来自 List SynonymMaps 请求的响应。 如果成功，它将包括所有同义词映射的完整定义。
SearchIndexerDataNoneIdentity

清除数据源的标识属性。
SearchIndexerDataUserAssignedIdentity

指定要使用的数据源的标识。
SearchResourceEncryptionKey

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

表示同义词映射定义。

Accept

枚举

接受（Accept）首部。

值 说明
application/json;odata.metadata=minimal

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称 类型 说明
info

附加信息。
type

string

附加信息类型。

ErrorDetail

对象

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

对象

所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。 （这也遵循 OData 错误响应格式）。

名称 类型 说明
error

ErrorDetail

错误对象。

ListSynonymMapsResult

对象

来自 List SynonymMaps 请求的响应。 如果成功，它将包括所有同义词映射的完整定义。

名称 类型 说明
value

SynonymMap[]

搜索服务中的同义词映射。

SearchIndexerDataNoneIdentity

对象

清除数据源的标识属性。

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

指定身份类型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

对象

指定要使用的数据源的标识。

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

指定身份类型的 URI 片段。
userAssignedIdentity

string

用户分配的托管标识的完全限定的 Azure 资源 ID 通常以“/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentity/myId”的形式分配给搜索服务。

SearchResourceEncryptionKey

对象

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

名称 类型 说明
accessCredentials.applicationId

string

向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure 密钥保管库 所需的访问权限。 应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
accessCredentials.applicationSecret

string

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

用于此加密密钥的显式托管标识。 如果未指定并且访问凭据属性为 null，则使用系统分配的托管标识。 更新资源时，如果未指定显式标识，则保持不变。 如果指定了“none”，则清除此属性的值。
keyVaultKeyName

string

用于加密静态数据的 Azure 密钥保管库 密钥的名称。
keyVaultKeyVersion

string

用于加密静态数据的 Azure 密钥保管库 密钥的版本。
keyVaultUri

string

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

SynonymMap

对象

表示同义词映射定义。

名称 类型 说明
@odata.etag

string

同义词映射的 ETag。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密你的数据时，这个密钥用于为你的数据提供额外的静止加密层。 加密数据后，数据将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果需要轮换加密密钥，可以根据需要更改此属性;你的数据将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
format enum:

solr

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

string

同义词映射的名称。
synonyms

string

指定同义词映射格式的一系列同义词规则。 规则必须用换行符分隔。