Synonym Maps - List

參考

服務:: Search Service

API 版本:: 2024-07-01

列出搜尋服務可用的所有同義字對應。

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

含選擇性參數:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2024-07-01

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	搜尋服務的端點 URL。
api-version	query	True	string	用戶端 API 版本。
$select	query		string	選取要擷取之同義字對應的最上層屬性。針對所有屬性指定為 JSON 屬性名稱的逗號分隔清單或『*』。預設值為所有屬性。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	隨要求一起傳送的追蹤標識碼，以協助偵錯。

回應

名稱	類型	Description
200 OK	ListSynonymMapsResult
Other Status Codes	ErrorResponse	錯誤回應。

範例

SearchServiceListSynonymMaps

範例要求

HTTP

GET https://myservice.search.windows.net/synonymmaps?api-version=2024-07-01

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "name": "mysynonymmap",
      "format": "solr",
      "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
      "encryptionKey": {
        "keyVaultKeyName": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": null
      }
    },
    {
      "name": "myothersynonymmap",
      "format": "solr",
      "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat",
      "encryptionKey": null
    }
  ]
}

定義

名稱	Description
AzureActiveDirectoryApplicationCredentials	為搜尋服務建立之已註冊應用程式的認證，用於對儲存在 Azure Key Vault 中的加密密鑰進行驗證存取。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ListSynonymMapsResult	來自清單 SynonymMaps 要求的回應。如果成功，它會包含所有同義字對應的完整定義。
SearchResourceEncryptionKey	Azure Key Vault 中客戶管理的加密密鑰。您建立和管理的金鑰可用來加密或解密待用數據，例如索引和同義字對應。
SynonymMap	表示同義字對應定義。
SynonymMapFormat	同義字對應的格式。目前僅支援『solr』格式。

AzureActiveDirectoryApplicationCredentials

為搜尋服務建立之已註冊應用程式的認證，用於對儲存在 Azure Key Vault 中的加密密鑰進行驗證存取。

名稱	類型	Description
applicationId	string	AAD 應用程式識別碼，已將待用數據加密時要使用的 Azure Key Vault 所需訪問許可權授與。應用程式標識碼不應與 AAD 應用程式的物件標識元混淆。
applicationSecret	string	指定 AAD 應用程式的驗證金鑰。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ListSynonymMapsResult

來自清單 SynonymMaps 要求的回應。如果成功，它會包含所有同義字對應的完整定義。

名稱	類型	Description
value	SynonymMap[]	搜尋服務中的同義字對應。

SearchResourceEncryptionKey

Azure Key Vault 中客戶管理的加密密鑰。您建立和管理的金鑰可用來加密或解密待用數據，例如索引和同義字對應。

名稱	類型	Description
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

表示同義字對應定義。

名稱	類型	Description
@odata.etag	string	同義字對應的 ETag。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當您想要完整保證，即使沒有Microsoft，也無法解密您的數據時，此密鑰會用來為您的數據提供額外的待用加密層級。加密數據之後，一律會保持加密狀態。搜尋服務會忽略將此屬性設定為 null 的嘗試。如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的數據不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
format	SynonymMapFormat	同義字對應的格式。目前僅支援『solr』格式。
name	string	同義字對應的名稱。
synonyms	string	指定同義字對應格式的一系列同義字規則。規則必須以換行符分隔。

SynonymMapFormat

同義字對應的格式。目前僅支援『solr』格式。

名稱	類型	Description
solr	string	選取同義字對應的SOLR格式。

共用方式為