Synonym Maps - Get

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

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

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

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string (uri)

検索サービスのエンドポイント URL。
synonymMapName
 path True

string

シノニム マップの名前。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 型 説明
Accept

Accept

Acceptヘッダーです。
x-ms-client-request-id

string (uuid)

要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

応答

名前 型 説明
200 OK

SynonymMap

要求は成功しました。
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前 説明
https://search.azure.com/.default

例

SearchServiceGetSynonymMap

要求のサンプル

GET https://typespecpreviewexampleservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2026-08-01-preview

応答のサンプル

状態コード:
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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

定義

名前 説明
Accept

Acceptヘッダーです。
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
SearchIndexerDataNoneIdentity

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

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

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

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

Accept

列挙

Acceptヘッダーです。

値 説明
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

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

名前 型 説明
info

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーに関する追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーの対象。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

SearchIndexerDataNoneIdentity

Object

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

名前 型 説明
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

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

SearchIndexerDataUserAssignedIdentity

Object

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

名前 型 説明
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

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

string

マルチテナント User-Assigned マネージドIDサポート:ユーザー割り当てのマネージデンティティIDとフェデレートするように設定されたマルチテンタントアプリのクライアントID。
userAssignedIdentity

string

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

SearchResourceEncryptionKey

Object

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

名前 型 規定値 説明
accessCredentials.applicationId

string

保存データの暗号化時に使用される Azure Key Vault に対する必要なアクセス許可が付与された AAD アプリケーション ID。 アプリケーション ID は、AAD アプリケーションのオブジェクト ID と混同しないでください。
accessCredentials.applicationSecret

string

指定した AAD アプリケーションの認証キー。
identity SearchIndexerDataIdentity:

この暗号化キーに使用する明示的なマネージド ID。 指定されず、アクセス資格情報プロパティが null の場合は、システム割り当てマネージド ID が使用されます。 リソースの更新時に、明示的な ID が指定されていない場合、変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。
isServiceLevelKey

boolean

False

このキーがサービスレベルキーかどうかを示すオプションの値です。 既定値は falseです。
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 enum:

solr

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

string

シノニム マップの名前。
synonyms

string

指定されたシノニム マップ形式の一連のシノニム ルール。 ルールは改行で区切る必要があります。