Synonym Maps - List

Služba:: Search Service

Verze rozhraní API:: 2025-09-01

Zobrazí seznam všech map synonym dostupných pro vyhledávací službu.

GET {endpoint}/synonymmaps?api-version=2025-09-01

S volitelnými parametry:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2025-09-01

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string	Verze rozhraní API klienta.
$select	query		string	Vybírá, které vlastnosti synonym na nejvyšší úrovni se mají načíst. Zadává se jako čárkami oddělený seznam názvů vlastností JSON nebo '*' pro všechny vlastnosti. Výchozí hodnota je všechny vlastnosti.

Hlavička požadavku

Název	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem na pomoc s laděním.

Odpovědi

Název	Typ	Description
200 OK	ListSynonymMapsResult
Other Status Codes	ErrorResponse	Chybová odpověď.

Příklady

SearchServiceListSynonymMaps

Ukázkový požadavek

HTTP

GET https://stableexampleservice.search.windows.net/synonymmaps?$select=&api-version=2025-09-01

Ukázková odpověď

Stavový kó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>"
        }
      }
    }
  ]
}

Definice

Název	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, která se používá pro ověřený přístup k šifrovacím klíčům uloženým v Azure Key Vault.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ListSynonymMapsResult	Odpověď z požadavku List SynonymMaps. Pokud bude úspěšná, bude obsahovat úplné definice všech map synonym.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.
SynonymMap	Představuje definici mapy synonym.
SynonymMapFormat	Formát mapy synonym. V současné době je podporován pouze formát 'solr'.

AzureActiveDirectoryApplicationCredentials

Objekt

Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, která se používá pro ověřený přístup k šifrovacím klíčům uloženým v Azure Key Vault.

Název	Typ	Description
applicationId	string	ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění k Azure Key Vault, které se má použít při šifrování neaktivních uložených dat. ID aplikace by nemělo být zaměňováno s ID objektu pro vaši aplikaci AAD.
applicationSecret	string	Ověřovací klíč zadané aplikace AAD.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Název	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Název	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Název	Typ	Description
error	ErrorDetail	Objekt chyby.

ListSynonymMapsResult

Objekt

Odpověď z požadavku List SynonymMaps. Pokud bude úspěšná, bude obsahovat úplné definice všech map synonym.

Název	Typ	Description
value	SynonymMap[]	Synonymum se mapuje ve vyhledávací službě.

SearchResourceEncryptionKey

Objekt

Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Název	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Azure Key Vault. Není vyžadováno, pokud místo toho používáte spravovanou identitu.
keyVaultKeyName	string	Název vašeho klíče Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI vašeho Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objekt

Představuje definici mapy synonym.

Název	Typ	Description
@odata.etag	string	Značka ETag mapy synonym.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně šifrování neaktivních uložených dat v případě, že chcete mít plnou jistotu, že nikdo, ani Microsoft, nemůže vaše data dešifrovat. Jakmile svá data zašifrujete, zůstanou vždy zašifrována. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby změnit, pokud chcete šifrovací klíč otočit; Vaše údaje nebudou ovlivněny. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
format	SynonymMapFormat	Formát mapy synonym. V současné době je podporován pouze formát 'solr'.
name	string	Název mapy synonym.
synonyms	string	Řada pravidel synonym v určeném formátu mapy synonym. Pravidla musí být oddělena novými řádky.

SynonymMapFormat

Výčet

Formát mapy synonym. V současné době je podporován pouze formát 'solr'.

Hodnota	Description
solr	Vybere formát SOLR pro mapování synonym.