Synonym Maps - List

Szolgáltatás:: Search Service

API-verzió:: 2026-04-01

Felsorolja a keresési szolgáltatáshoz elérhető összes szinonimatérképet.

GET {endpoint}/synonymmaps?api-version=2026-04-01

Opcionális paraméterekkel:

GET {endpoint}/synonymmaps?api-version=2026-04-01&$select={$select}

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának URL-címe.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.
$select	query		string[]	Kiválasztja, mely felső szintű tulajdonságokat kell visszanyerni. A JSON-tulajdonságnevek vesszővel tagolt listájaként vagy az összes tulajdonság "*" értékeként van megadva. Az alapértelmezett érték az összes tulajdonság.

Kérelem fejléce

Name	Kötelező	Típus	Description
Accept		Accept	Az Elfogadás fejléce.
x-ms-client-request-id		string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Válaszok

Name	Típus	Description
200 OK	ListSynonymMapsResult	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Name	Description
https://search.azure.com/.default

Példák

SearchServiceListSynonymMaps

Mintakérelem

HTTP

GET https://exampleservice.search.windows.net/synonymmaps?api-version=2026-04-01&$select=

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "@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
Accept	Az Elfogadás fejléce.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
ListSynonymMapsResult	Válasz egy List SynonymMaps kérésre. Ha sikeres, tartalmazza az összes szinonimatérkép teljes definícióját.
SearchIndexerDataNoneIdentity	Törli az adatforrás identitástulajdonsá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.

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Tárgy

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

Name	Típus	Description
info		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 hiba célpontja.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ListSynonymMapsResult

Tárgy

Válasz egy List SynonymMaps kérésre. Ha sikeres, tartalmazza az összes szinonimatérkép teljes definícióját.

Name	Típus	Description
value	SynonymMap[]	A szinonimatérképek a Keresés szolgáltatásban.

SearchIndexerDataNoneIdentity

Tárgy

Törli az adatforrás identitástulajdonsá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 "/subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" formában található, 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.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.
accessCredentials.applicationSecret	string	A megadott AAD-alkalmazás hitelesítési kulcsa.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicit felügyelt identitás ehhez a titkosítási kulcshoz. Ha nincs megadva, és a hozzáférési hitelesítő adatok tulajdonság null értékű, akkor 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 meghatározva, az változatlan marad. Ha nincs megadva, a tulajdonság értéke törlődik.
keyVaultKeyName	string	A inaktív adatok titkosításához használandó Azure Key Vault-kulcs neve.
keyVaultKeyVersion	string	Az Azure Key Vault-kulcs inaktív adatok titkosításához használandó verziója.
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álandó kulcsot. Példa URI lehet `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 ETagje.
encryptionKey	SearchResourceEncryptionKey	Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson az adataid számára, amikor teljes biztosítékot szeretnél abban, hogy senki, még a Microsoft sem, nem tudja visszafejteni az adataidat. Miután titkosította az adatokat, az mindig titkosítva marad. 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. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az adatok nem lesznek hatással. Az ügyfél által felügyelt kulcsokkal rendelkező 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	enum: solr	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.