Synonym Maps - Create Or Update

サービス:
Search Service
API バージョン:
2025-08-01-preview

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

PUT {endpoint}/synonymmaps('{synonymMapName}')?api-version=2025-08-01-preview

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

ErrorResponse

エラー応答。

例

SearchServiceCreateOrUpdateSynonymMap

要求のサンプル

PUT https://previewexampleservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2025-08-01-preview





{
  "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>"
    }
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

応答のサンプル

状態コード:
200 
{
  "@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>"
    }
  }
}
状態コード:
201 
{
  "@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>"
    }
  }
}

定義

名前 説明
AzureActiveDirectoryApplicationCredentials

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

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
SearchIndexerDataNoneIdentity

データソースの identity プロパティをクリアします。
SearchIndexerDataUserAssignedIdentity

使用するデータソースの ID を指定します。
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 アプリケーションの認証キー。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

SearchIndexerDataNoneIdentity

Object

データソースの identity プロパティをクリアします。

名前 型 説明
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

ID のタイプを指定する URI フラグメント。

SearchIndexerDataUserAssignedIdentity

Object

使用するデータソースの ID を指定します。

名前 型 説明
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

ID のタイプを指定する URI フラグメント。
userAssignedIdentity

string

ユーザーが割り当てたマネージド ID の完全修飾 Azure リソース ID は、通常、検索サービスに割り当てられている必要がある "/subscriptions/1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" の形式です。

SearchResourceEncryptionKey

Object

Azure Key Vault の顧客管理暗号化キー。 作成および管理するキーを使用して、インデックスやシノニム マップなどの保存データの暗号化または暗号化解除を行うことができます。

名前 型 説明
accessCredentials

AzureActiveDirectoryApplicationCredentials

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

この暗号化キーに使用する明示的なマネージド ID。 指定されておらず、アクセス資格情報プロパティが null の場合は、システム割り当てマネージド ID が使用されます。 リソースの更新時に、明示的な ID が指定されていない場合は、変更されません。 "none" を指定すると、このプロパティの値はクリアされます。
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 形式を選択します。