Synonym Maps - Create Or Update

リファレンス

サービス:: Search Service

API バージョン:: 2023-11-01

新しいシノニムマップを作成するか、シノニムマップが既に存在する場合は更新します。

PUT {endpoint}/synonymmaps('{synonymMapName}')?api-version=2023-11-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
synonymMapName	path	True	string	作成または更新するシノニムマップの名前。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	デバッグに役立つ要求と共に送信された追跡 ID。
If-Match		string	If-Match 条件を定義します。この操作は、サーバー上の ETag がこの値と一致する場合にのみ実行されます。
If-None-Match		string	If-None-Match 条件を定義します。この操作は、サーバー上の ETag がこの値と一致しない場合にのみ実行されます。
Prefer	True	string	HTTP PUT 要求の場合は、正常に作成または更新されたリソースを返すようにサービスに指示します。

要求本文

名前	必須	型	説明
format	True	SynonymMapFormat	シノニムマップの形式。現在、'solr' 形式のみがサポートされています。
name	True	string	シノニムマップの名前。
synonyms	True	string	指定したシノニムマップ形式の一連のシノニムルール。規則は改行で区切る必要があります。
@odata.etag		string	シノニムマップの ETag。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vaultで作成する暗号化キーの説明。このキーは、Microsoft 以外のユーザーが機密データの暗号化を解除できないという完全な保証が必要な場合に、データの保存時の追加レベルを提供するために使用されます。データを暗号化すると、常に暗号化されたままになります。このプロパティを null に設定しようとすると、検索サービスは無視されます。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データは影響を受けません。カスタマーマネージドキーを使用した暗号化は無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

応答

名前	型	説明
200 OK	SynonymMap
201 Created	SynonymMap
Other Status Codes	SearchError	エラー応答。

例

SearchServiceCreateOrUpdateSynonymMap

要求のサンプル

HTTP

PUT https://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2023-11-01


{
  "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": null
  }
}

応答のサンプル

状態コード:: 200

{
  "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": null
  }
}

状態コード:: 201

{
  "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": null
  }
}

定義

名前	説明
AzureActiveDirectoryApplicationCredentials	Azure Key Vaultに格納されている暗号化キーへの認証済みアクセスに使用される、検索サービス用に作成された登録済みアプリケーションの資格情報。
SearchError	API のエラー条件について説明します。
SearchResourceEncryptionKey	Azure Key Vaultのカスタマーマネージド暗号化キー。作成および管理するキーを使用すると、インデックスやシノニムマップなど、検索サービスの保存データを暗号化または暗号化解除できます。
SynonymMap	シノニムマップ定義を表します。
SynonymMapFormat	シノニムマップの形式。現在、'solr' 形式のみがサポートされています。

AzureActiveDirectoryApplicationCredentials

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

名前	型	説明
applicationId	string	保存データの暗号化時に使用される Azure Key Vaultに必要なアクセス許可が付与された AAD アプリケーション ID。アプリケーション ID は、AAD アプリケーションのオブジェクト ID と混同しないでください。
applicationSecret	string	指定した AAD アプリケーションの認証キー。

SearchError

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

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
details	SearchError[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
message	string	エラーの人間が判読できる表現。

SearchResourceEncryptionKey

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

シノニムマップ定義を表します。

名前	型	説明
@odata.etag	string	シノニムマップの ETag。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vaultで作成する暗号化キーの説明。このキーは、Microsoft 以外のユーザーが機密データの暗号化を解除できないという完全な保証が必要な場合に、データの保存時の追加レベルを提供するために使用されます。データを暗号化すると、常に暗号化されたままになります。このプロパティを null に設定しようとすると、検索サービスは無視されます。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データは影響を受けません。カスタマーマネージドキーを使用した暗号化は無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
format	SynonymMapFormat	シノニムマップの形式。現在、'solr' 形式のみがサポートされています。
name	string	シノニムマップの名前。
synonyms	string	指定したシノニムマップ形式の一連のシノニムルール。規則は改行で区切る必要があります。

SynonymMapFormat

シノニムマップの形式。現在、'solr' 形式のみがサポートされています。

名前	型	説明
solr	string	シノニムマップの SOLR 形式を選択します。

次の方法で共有