Synonym Maps - Get

Szolgáltatás:: Search Service

API-verzió:: 2025-08-01-preview

Lekér egy szinonimatérkép-definíciót.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végpontjának URL-címe.
synonymMapName	path	True	string	A lekérni kívánt szinonimatérkép neve.
api-version	query	True	string	Ügyfél API verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A hibakeresési kérelemmel küldött nyomkövetési azonosító.

Válaszok

Name	Típus	Description
200 OK	SynonymMap
Other Status Codes	ErrorResponse	Hibaválasz.

Példák

SearchServiceGetSynonymMap

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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>"
    }
  }
}

Definíciók

Name	Description
AzureActiveDirectoryApplicationCredentials	A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyek a Azure Key Vault tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használatosak.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
SearchIndexerDataNoneIdentity	Törli egy adatforrás identity tulajdonságát.
SearchIndexerDataUserAssignedIdentity	Megadja a használni kívánt adatforrás identitását.
SearchResourceEncryptionKey	Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók.
SynonymMap	Szinonimatérkép-definíciót jelöl.
SynonymMapFormat	A szinonimatérkép formátuma. Jelenleg csak a "solr" formátum támogatott.

AzureActiveDirectoryApplicationCredentials

Tárgy

A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyek a Azure Key Vault tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használatosak.

Name	Típus	Description
applicationId	string	Egy AAD-alkalmazásazonosító, amely megkapta a szükséges hozzáférési engedélyeket az Azure Key Vaulthoz, amelyet az inaktív adatok titkosításához kell használni. Az alkalmazásazonosító nem tévesztendő össze az AAD-alkalmazás objektumazonosítójával.
applicationSecret	string	A megadott AAD-alkalmazás hitelesítési kulcsa.

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

SearchIndexerDataNoneIdentity

Tárgy

Törli egy adatforrás identity tulajdonságát.

Name	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Az identitás típusát meghatározó URI-töredék.

SearchIndexerDataUserAssignedIdentity

Tárgy

Megadja a használni kívánt adatforrás identitását.

Name	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Az identitás típusát meghatározó URI-töredék.
userAssignedIdentity	string	A felhasználó által hozzárendelt felügyelt identitás teljes Azure-erőforrás-azonosítója, általában a következő formátumban: "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", amelyet hozzá kellett volna rendelni a keresési szolgáltatáshoz.

SearchResourceEncryptionKey

Tárgy

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók.

Name	Típus	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	A Azure Key Vault eléréséhez használt opcionális Azure Active Directory hitelesítő adatok. Nem szükséges, ha felügyelt identitást használ.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A titkosítási kulcshoz használandó explicit felügyelt identitás. Ha nincs megadva, és a hozzáférési hitelesítő adatok tulajdonsága null, a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Az erőforrás frissítésekor, ha az explicit identitás nincs megadva, az változatlan marad. Ha a "nincs" van megadva, a tulajdonság értéke törlődik.
keyVaultKeyName	string	Az inaktív adatok titkosításához használt Azure Key Vault kulcs neve.
keyVaultKeyVersion	string	Az Azure Key Vault kulcs verziója, amely az inaktív adatok titkosításához használható.
keyVaultUri	string	Az Azure Key Vault URI-ja, más néven DNS-név, amely tartalmazza az inaktív adatok titkosításához használt kulcsot. Példa lehet az URI-ra `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Tárgy

Szinonimatérkép-definíciót jelöl.

Name	Típus	Description
@odata.etag	string	A szinonimatérkép ETag-je.
encryptionKey	SearchResourceEncryptionKey	A Azure Key Vault létrehozott titkosítási kulcs leírása. Ez a kulcs arra szolgál, hogy további titkosítási szintet biztosítson az adatokhoz, ha teljes körű biztosítékot szeretne biztosítani arra, hogy senki, még a Microsoft sem tudja visszafejteni az adatokat. Miután titkosította adatait, azok mindig titkosítva maradnak. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatja, ha el szeretné forgatni a titkosítási kulcsot; Az Ön adatait ez nem érinti. Az ügyfél által felügyelt kulcsokkal való titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.
format	SynonymMapFormat	A szinonimatérkép formátuma. Jelenleg csak a "solr" formátum támogatott.
name	string	A szinonimatérkép neve.
synonyms	string	Szinonimaszabályok sorozata a megadott szinonimatérkép-formátumban. A szabályokat új sorokkal kell elválasztani.

SynonymMapFormat

Felsorolás

A szinonimatérkép formátuma. Jelenleg csak a "solr" formátum támogatott.

Érték	Description
solr	Kiválasztja a szinonimatérképek SOLR formátumát.