Synonym Maps - Create
Vytvoří novou mapu synonym.
POST {endpoint}/synonymmaps?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. |
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. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
format | True |
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 |
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, pokud chcete mít plnou jistotu, že nikdo, ani Microsoft, nemůže dešifrovat vaše citlivá data. 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 |
---|---|---|
201 Created | ||
Other Status Codes |
Odpověď na chybu. |
Příklady
SearchServiceCreateSynonymMap
Ukázkový požadavek
POST https://myservice.search.windows.net/synonymmaps?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": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "myApplicationSecret"
}
}
}
Ukázková odpověď
{
"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": null
}
}
}
Definice
Name | Description |
---|---|
Azure |
Přihlašovací údaje zaregistrované aplikace vytvořené pro vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým v Azure Key Vault. |
Search |
Popisuje chybový stav rozhraní API. |
Search |
Š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 ve vyhledávací službě, jako jsou indexy a mapy synonym. |
Synonym |
Představuje definici mapy synonym. |
Synonym |
Formát mapy synonym. V současné době je podporován pouze formát "solr". |
AzureActiveDirectoryApplicationCredentials
Přihlašovací údaje zaregistrované aplikace vytvořené pro 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 chybový stav rozhraní API.
Name | Typ | Description |
---|---|---|
code |
string |
Jeden ze serverem definované sady kódů chyb. |
details |
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, 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.
Name | Typ | Description |
---|---|---|
accessCredentials |
Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Key Vault Azure. Nevyžaduje se, pokud místo toho použijete 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 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 |
SynonymMap
Představuje definici mapy synonym.
Name | Typ | Description |
---|---|---|
@odata.etag |
string |
Značka ETag mapy synonym. |
encryptionKey |
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, pokud chcete mít plnou jistotu, že nikdo, ani Microsoft, nemůže dešifrovat vaše citlivá data. 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 |
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. |