Synonym Maps - List

サービス:
Search Service
API バージョン:
2023-11-01

検索サービスで使用できるすべてのシノニム マップを一覧表示します。

GET {endpoint}/synonymmaps?api-version=2023-11-01
省略可能なパラメーターを含む: 
GET {endpoint}/synonymmaps?$select={$select}&api-version=2023-11-01

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

検索サービスのエンドポイント URL。
api-version
 query True

string

クライアント API のバージョン。
$select
 query

string

取得するシノニム マップの最上位のプロパティを選択します。 JSON プロパティ名のコンマ区切りリストとして指定するか、すべてのプロパティの * として指定します。 既定値は、すべてのプロパティです。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string (uuid)

デバッグに役立つ要求と共に送信される追跡 ID。

応答

名前 型 説明
200 OK

ListSynonymMapsResult

Other Status Codes

SearchError

エラー応答。

例

SearchServiceListSynonymMaps

要求のサンプル

GET https://myservice.search.windows.net/synonymmaps?api-version=2023-11-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
    }
  ]
}

定義

名前 説明
AzureActiveDirectoryApplicationCredentials

Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用される、検索サービス用に作成された登録済みアプリケーションの資格情報。
ListSynonymMapsResult

List SynonymMaps 要求からの応答。 成功した場合は、すべてのシノニム マップの完全な定義が含まれます。
SearchError

API のエラー条件について説明します。
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 アプリケーションの認証キー。

ListSynonymMapsResult

Object

List SynonymMaps 要求からの応答。 成功した場合は、すべてのシノニム マップの完全な定義が含まれます。

名前 型 説明
value

SynonymMap[]

シノニムは Search サービス内でマップされます。

SearchError

Object

API のエラー条件について説明します。

名前 型 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。
details

SearchError[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message

string

エラーの人間が判読できる表現。

SearchResourceEncryptionKey

Object

Azure Key Vault のカスタマー マネージド暗号化キー。 作成および管理するキーは、インデックスやシノニム マップなど、検索サービスの保存データを暗号化または復号化するために使用できます。

名前 型 説明
accessCredentials

AzureActiveDirectoryApplicationCredentials

Azure Key Vault へのアクセスに使用されるオプションの Azure Active Directory 資格情報。 代わりにマネージド ID を使用する場合は必要ありません。
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

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 形式を選択します。