Synonym Maps - Create Or Update

Reference

Služba:: Search Service

Verze rozhraní API:: 2023-11-01

Vytvoří novou mapu synonym nebo aktualizuje mapu synonym, pokud již existuje.

PUT {endpoint}/synonymmaps('{synonymMapName}')?api-version=2023-11-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
synonymMapName	path	True	string	Název mapy synonym pro vytvoření nebo aktualizaci.
api-version	query	True	string	Verze rozhraní API klienta.

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.
If-Match		string	Definuje If-Match podmínku. Operace se provede pouze v případě, že značka ETag na serveru odpovídá této hodnotě.
If-None-Match		string	Definuje podmínku If-None-Match. Operace se provede pouze v případě, že značka ETag na serveru neodpovídá této hodnotě.
Prefer	True	string	V případě požadavků HTTP PUT dává službě pokyn, aby v případě úspěchu vrátila vytvořený nebo aktualizovaný prostředek.

Text požadavku

Name	Vyžadováno	Typ	Description
format	True	SynonymMapFormat	Formát mapy synonym. V současné době je podporován pouze formát "solr".
name	True	string	Název mapy synonym.
synonyms	True	string	Řada pravidel synonym v zadaném formátu mapy synonym. Pravidla musí být oddělena novými spojnicemi.
@odata.etag		string	Značka 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í neaktivních uložených dat, když chcete mít plnou jistotu, že nikdo, dokonce ani Microsoft, nemůže vaše citlivá 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.

Odpovědi

Name	Typ	Description
200 OK	SynonymMap
201 Created	SynonymMap
Other Status Codes	SearchError	Chybová odpověď.

Příklady

SearchServiceCreateOrUpdateSynonymMap

Ukázkový požadavek

HTTP

PUT https://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2023-11-01


{
  "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": null
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "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": null
  }
}

Stavový kód:: 201

{
  "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": 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.
SearchError	Popisuje chybovou podmínku rozhraní API.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, se dají použít k šifrování nebo dešifrování neaktivních uložených dat ve vyhledávací službě, 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.

SearchError

Popisuje chybovou podmínku rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

SearchResourceEncryptionKey

Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, se dají použít k šifrování nebo dešifrování neaktivních uložených dat ve vyhledávací službě, 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.
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íč slouží 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 citlivá 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