Synonym Maps - List

參考

Service:: Search Service

API Version:: 2023-10-01-Preview

清單搜尋服務可用的所有同義字對應。

GET {endpoint}/synonymmaps?api-version=2023-10-01-Preview

With optional parameters:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2023-10-01-Preview

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	SearchError	錯誤回應。

範例

SearchServiceListSynonymMaps

Sample Request

HTTP

GET https://myservice.search.windows.net/synonymmaps?api-version=2023-10-01-Preview

Sample Response

Status code:: 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 金鑰保存庫中所儲存加密金鑰的存取權。
ListSynonymMapsResult	來自 List SynonymMaps 要求的回應。如果成功，它會包含所有同義字對應的完整定義。
SearchError	描述 API 的錯誤狀況。
SearchIndexerDataNoneIdentity	清除資料源的識別屬性。
SearchIndexerDataUserAssignedIdentity	指定要使用之數據源的身分識別。
SearchResourceEncryptionKey	Azure 金鑰保存庫中客戶管理的加密密鑰。您建立和管理的金鑰可用來加密或解密待用數據，例如索引和同義字對應。
SynonymMap	表示同義字對應定義。
SynonymMapFormat	同義字對應的格式。目前僅支援『solr』格式。

AzureActiveDirectoryApplicationCredentials

為搜尋服務建立之已註冊應用程式的認證，用於驗證 Azure 金鑰保存庫中所儲存加密金鑰的存取權。

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

ListSynonymMapsResult

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

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

SearchError

描述 API 的錯誤狀況。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	SearchError[]	導致此錯誤之特定錯誤的詳細數據陣列。
message	string	人類可讀取的錯誤表示法。

SearchIndexerDataNoneIdentity

清除資料源的識別屬性。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	指定身分識別類型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

指定要使用之數據源的身分識別。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	指定身分識別類型的 URI 片段。
userAssignedIdentity	string	使用者指派受控識別的完整 Azure 資源標識符，通常格式為 “/subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId”，應該已指派給搜尋服務。

SearchResourceEncryptionKey

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

名稱	類型	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	用來存取 Azure 金鑰保存庫的選擇性 Azure Active Directory 認證。若改用受控識別，則不需要。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	要用於此加密金鑰的明確受控識別。如果未指定，且存取認證屬性為 Null，則會使用系統指派的受控識別。更新資源時，如果未指定明確的身分識別，則會維持不變。如果指定了「none」則會清除此屬性的值。
keyVaultKeyName	string	要用來加密待用數據的 Azure 金鑰保存庫金鑰名稱。
keyVaultKeyVersion	string	要用來加密待用數據的 Azure 金鑰保存庫金鑰版本。
keyVaultUri	string	Azure 金鑰保存庫的 URI 也稱為 DNS 名稱，其中包含用來加密待用數據的密鑰。範例 URI 可能是 `https://my-keyvault-name.vault.azure.net`。

SynonymMap

表示同義字對應定義。

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

SynonymMapFormat

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

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

共用方式為