Synonym Maps - List

Reference

Služba:: Search Service

Verze rozhraní API:: 2024-05-01-preview

Seznamy všechny mapy synonym dostupné pro vyhledávací službu.

GET {endpoint}/synonymmaps?api-version=2024-05-01-preview

S volitelnými parametry:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2024-05-01-preview

Parametry identifikátoru URI

Name	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	Vybere, které vlastnosti na nejvyšší úrovni se mapují synonyma, které se mají načíst. Určuje se jako seznam názvů vlastností JSON oddělených čárkami nebo *pro všechny vlastnosti. Výchozí hodnota je všechny vlastnosti.

Hlavička požadavku

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

Odpovědi

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

Příklady

SearchServiceListSynonymMaps

Ukázkový požadavek

HTTP

GET https://myservice.search.windows.net/synonymmaps?api-version=2024-05-01-preview

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "name": "mysynonymmap",
      "format": "solr",
      "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
      "encryptionKey": {
        "keyVaultKeyName": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": null
      }
    },
    {
      "name": "myothersynonymmap",
      "format": "solr",
      "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat",
      "encryptionKey": null
    }
  ]
}

Definice

Name	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, které slouží k ověřenému přístupu 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 V případě úspěchu zahrnuje úplné definice všech map synonym.
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 v Azure Key Vault. Klíče, které vytvoříte a spravujete, můžete 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

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

Name	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 mají použít při šifrování neaktivních uložených dat. ID aplikace by se nemělo zaměňovat s ID objektu vaší aplikace AAD.
applicationSecret	string	Ověřovací klíč zadané aplikace AAD.

ErrorAdditionalInfo

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

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	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

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ListSynonymMapsResult

Odpověď z požadavku List SynonymMaps V případě úspěchu zahrnuje úplné definice všech map synonym.

Name	Typ	Description
value	SynonymMap[]	Synonymum se mapuje v Search.

SearchIndexerDataNoneIdentity

Vymaže vlastnost identity zdroje dat.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identifikátoru URI určující typ identity.

SearchIndexerDataUserAssignedIdentity

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

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identifikátoru URI určující typ identity.
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ělo být přiřazeno vyhledávací službě.

SearchResourceEncryptionKey

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

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k azure Key Vault. Nevyžaduje se, pokud místo toho používáte spravovanou identitu.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadaný a vlastnost přihlašovacích údajů přístupu má hodnotu null, použije se spravovaná identita přiřazená systémem. Pokud po aktualizaci prostředku explicitní identita není určená, zůstane beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti bude vymazána.
keyVaultKeyName	string	Název 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 Key Vault Azure, 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

Představuje definici mapy synonym.

Name	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 zajištění další úrovně šifrování neaktivních uložených dat, když chcete mít plnou jistotu, že nikdo, dokonce ani Microsoft, nemůže vaše data dešifrovat. Jakmile data zašifrujete, zůstanou vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Na vaše data to nebude mít vliv. Š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 zadaném formátu mapy synonym. Pravidla musí být oddělena novými spojnicemi.

SynonymMapFormat

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

Name	Typ	Description
solr	string	Vybere formát SOLR pro mapy synonym.

Sdílet prostřednictvím