Synonym Maps - Create Or Update

Služba:
Search Service
Verze rozhraní API:
2023-11-01

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

PUT {endpoint}/synonymmaps('{synonymMapName}')?api-version=2023-11-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.
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

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

string (uuid)

ID sledování odeslané s požadavkem, které vám pomůže s laděním.
If-Match

string

Definuje podmínku If-Match. Operace bude provedena pouze v případě, že značky ETag na serveru odpovídají této hodnotě.
If-None-Match

string

Definuje podmínku If-None-Match. Operace bude provedena pouze v případě, že značky ETag na serveru neodpovídají této hodnotě.
Prefer True

string

U požadavků HTTP PUT dává službě pokyn k vrácení vytvořeného nebo aktualizovaného prostředku při úspěchu.

Text požadavku

Název Vyžadováno Typ Description
format True

SynonymMapFormat

Formát mapy synonym. V současné době se podporuje pouze formát solr.
name True

string

Název mapy synonym.
synonyms True

string

Řada pravidel synonym v zadaném formátu mapování synonym. Pravidla musí být oddělena novými spojnicemi.
@odata.etag

string

Symbol ETag mapy synonym.
encryptionKey

SearchResourceEncryptionKey

Popis šifrovacího klíče, který vytvoříte ve službě Azure Key Vault. Tento klíč slouží k zajištění další úrovně neaktivních uložených šifrování dat, pokud chcete mít plnou jistotu, že citlivá data může dešifrovat nikdo, ani Microsoft. 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 po 1. lednu 2019.

Odpovědi

Název Typ Description
200 OK

SynonymMap

201 Created

SynonymMap

Other Status Codes

SearchError

Chybová odpověď.

Příklady

SearchServiceCreateOrUpdateSynonymMap

Ukázkový požadavek

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

Název 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 ve službě Azure Key Vault.
SearchError

Popisuje chybový stav rozhraní API.
SearchResourceEncryptionKey

Šifrovací klíč spravovaný zákazníkem ve službě 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 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ě se podporuje pouze formát solr.

AzureActiveDirectoryApplicationCredentials

Objekt

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 ve službě Azure Key Vault.

Název Typ Description
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.
applicationSecret

string

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

SearchError

Objekt

Popisuje chybový stav rozhraní API.

Název Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
details

SearchError[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message

string

Čitelné znázornění chyby člověkem.

SearchResourceEncryptionKey

Objekt

Šifrovací klíč spravovaný zákazníkem ve službě 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 ve vyhledávací službě, 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 ke službě Azure Key Vault. Nevyžaduje se, pokud místo toho používáte spravovanou identitu.
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 ve službě Azure Key Vault. Tento klíč slouží k zajištění další úrovně neaktivních uložených šifrování dat, pokud chcete mít plnou jistotu, že citlivá data může dešifrovat nikdo, ani Microsoft. 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 po 1. lednu 2019.
format

SynonymMapFormat

Formát mapy synonym. V současné době se podporuje pouze formát solr.
name

string

Název mapy synonym.
synonyms

string

Řada pravidel synonym v zadaném formátu mapování synonym. Pravidla musí být oddělena novými spojnicemi.

SynonymMapFormat

Výčet

Formát mapy synonym. V současné době se podporuje pouze formát solr.

Hodnota Description
solr

Vybere formát SOLR pro mapy synonym.