Synonym Maps - Get

Služba:
Search Service
Verze rozhraní API:
2026-08-01-preview

Načte definici mapy synonym.

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

Parametry identifikátoru URI

Název V Vyžadováno Typ Description
endpoint
 path True

string (uri)

Adresa URL koncového bodu vyhledávací služby.
synonymMapName
 path True

string

Název mapy synonym.
api-version
 query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název Vyžadováno Typ Description
x-ms-client-request-id

string (uuid)

Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.
Accept

Accept

Hlavička Accept.

Odpovědi

Název Typ Description
200 OK

SynonymMap

Požadavek byl úspěšný.
Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Název Description
https://search.azure.com/.default

Příklady

SearchServiceGetSynonymMap

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definice

Název Description
Accept

Hlavička Accept.
ErrorAdditionalInfo

Další informace o chybě při správě prostředků
ErrorDetail

Podrobnosti o chybě.
ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
SearchIndexerDataNoneIdentity

Vymaže vlastnost identity zdroje dat.
SearchIndexerDataUserAssignedIdentity

Určuje identitu zdroje dat, která se má použít.
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.

Accept

Výčet

Hlavička Accept.

Hodnota Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Další informace o chybě při správě prostředků

Název Typ Description
info

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

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Název Typ Description
error

ErrorDetail

Objekt chyby.

SearchIndexerDataNoneIdentity

Objekt

Vymaže vlastnost identity zdroje dat.

Název Typ Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Fragment identifikátoru URI určující typ identity.

SearchIndexerDataUserAssignedIdentity

Objekt

Určuje identitu zdroje dat, která se má použít.

Název Typ Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Fragment identifikátoru URI určující typ identity.
federatedIdentityClientId

string

Multi-tenant User-Assigned Managed Identity Support: Klientské ID multi-tentant aplikace, které bylo nakonfigurováno tak, aby federovalo s uživatelem přiřazenou spravovanou identitou.
userAssignedIdentity

string

Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu /subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId, které by měly být přiřazeny 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 Default value Description
accessCredentials.applicationId

string

ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění ke službě 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.
accessCredentials.applicationSecret

string

Ověřovací klíč zadané aplikace AAD.
identity SearchIndexerDataIdentity:

Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána.
isServiceLevelKey

boolean

False

Volitelná hodnota označující, zda je tento klíč klíčem na úrovni služby. Výchozí hodnota je nastavená na false.
keyVaultKeyName

string

Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion

string

Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri

string

Identifikátor URI služby 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

Symbol ETag mapy synonym.
encryptionKey

SearchResourceEncryptionKey

Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k zajištění další úrovně šifrování v klidu vašich dat, když chcete mít plnou jistotu, že nikdo, ani Microsoft, vaše data nedokáže dešifrovat. Jakmile data zašifrujete, zůstane vždy zašifrovaná. 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 data nebudou ovlivněna. Š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 enum:

solr

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.