Synonym Maps - Create

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

Vytvoří novou mapu synonym.

POST {endpoint}/synonymmaps?api-version=2025-08-01-preview

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.
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 na pomoc s laděním.

Text požadavku

Název 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 určeném formátu mapy synonym. Pravidla musí být oddělena novými řádky.
@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 poskytnutí další úrovně šifrování neaktivních uložených dat v případě, že chcete mít plnou jistotu, že nikdo, ani Microsoft, nemůže vaše data dešifrovat. Jakmile svá data zašifrujete, zůstanou vždy zašifrována. 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 údaje nebudou ovlivněny. Š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

Název Typ Description
201 Created

SynonymMap

Other Status Codes

ErrorResponse

Chybová odpověď.

Příklady

SearchServiceCreateSynonymMap

Ukázkový požadavek

POST https://previewexampleservice.search.windows.net/synonymmaps?api-version=2025-08-01-preview


{
  "name": "tempsynonymmap",
  "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": "<applicationSecret>"
    }
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

Ukázková odpověď

Stavový kód:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempsynonymmap",
  "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": "<applicationSecret>"
    }
  }
}

Definice

Název Description
AzureActiveDirectoryApplicationCredentials

Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, která se používá pro ověřený přístup 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ěď
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.
SynonymMapFormat

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

AzureActiveDirectoryApplicationCredentials

Objekt

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

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

ErrorAdditionalInfo

Objekt

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

Název Typ Description
info

object

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

Chybová odpověď

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.
userAssignedIdentity

string

Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu "/subscriptions/12345678-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

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 Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Azure Key Vault. Není vyžadováno, pokud místo toho používáte spravovanou identitu.
identity SearchIndexerDataIdentity:

Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadán a vlastnost přístupových přihlašovacích údajů má hodnotu null, použije se spravovaná identita přiřazená systémem. Pokud při aktualizaci prostředku není explicitní identita určena, zůstane nezměněna. Pokud je zadáno "none", hodnota této vlastnosti je vymazána.
keyVaultKeyName

string

Název vašeho 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 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

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 poskytnutí další úrovně šifrování neaktivních uložených dat v případě, že chcete mít plnou jistotu, že nikdo, ani Microsoft, nemůže vaše data dešifrovat. Jakmile svá data zašifrujete, zůstanou vždy zašifrována. 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 údaje nebudou ovlivněny. Š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 určeném formátu mapy synonym. Pravidla musí být oddělena novými řádky.

SynonymMapFormat

Výčet

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

Hodnota Description
solr

Vybere formát SOLR pro mapování synonym.