Synonym Maps - Create

Tjänst:: Search Service

API-version:: 2026-08-01-preview

Skapar en ny synonymmappning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.
Accept		Accept	Acceptera-rubriken.

Begärandetext

Name	Obligatorisk	Typ	Description
format	True	enum: solr	Formatet för synonymmappningen. Endast "solr"-formatet stöds för närvarande.
name	True	string	Namnet på synonymkartan.
synonyms	True	string	En serie synonymregler i det angivna synonymmappningsformatet. Reglerna måste separeras med nya rader.
@odata.etag		string	ETag för synonymkartan.
encryptionKey		SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Denna nyckel används för att ge en extra nivå av kryptering i vila för dina data när du vill ha full säkerhet att ingen, inte ens Microsoft, kan dekryptera dina data. När du har krypterat dina data förblir de alltid krypterade. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Dina data påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.

Svar

Name	Typ	Description
201 Created	SynonymMap	Begäran har slutförts och en ny resurs har skapats som ett resultat.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://search.azure.com/.default

Exempel

SearchServiceCreateSynonymMap

Exempelbegäran

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/synonymmaps?api-version=2026-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"
}

Exempelsvar

Statuskod:: 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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definitioner

Name	Description
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
SearchIndexerDataNoneIdentity	Rensar identitetsegenskapen för en datakälla.
SearchIndexerDataUserAssignedIdentity	Anger identiteten för en datakälla som ska användas.
SearchResourceEncryptionKey	En kundhanterad krypteringsnyckel i Azure Key Vault. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymmappningar.
SynonymMap	Representerar en synonymmappningsdefinition.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felobjektet.

SearchIndexerDataNoneIdentity

Objekt

Rensar identitetsegenskapen för en datakälla.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Ett URI-fragment som anger typen av identitet.

SearchIndexerDataUserAssignedIdentity

Objekt

Anger identiteten för en datakälla som ska användas.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ett URI-fragment som anger typen av identitet.
federatedIdentityClientId	string	Multi-tenant User-Assigned Managed Identity Support: Klient-ID:t för den multi-tentant-appen som har konfigurerats för att federera med den användartilldelade hanterade identiteten.
userAssignedIdentity	string	Det fullständigt kvalificerade Azure-resurs-ID:t för en användartilldelad hanterad identitet, vanligtvis i formuläret "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" som borde ha tilldelats söktjänsten.

SearchResourceEncryptionKey

Objekt

En kundhanterad krypteringsnyckel i Azure Key Vault. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymmappningar.

Name	Typ	Standardvärde	Description
accessCredentials.applicationId	string		Ett AAD-program-ID som har beviljats nödvändiga åtkomstbehörigheter till Azure Key Vault som ska användas när du krypterar dina data i vila. Program-ID:t bör inte förväxlas med objekt-ID:t för ditt AAD-program.
accessCredentials.applicationSecret	string		Autentiseringsnyckeln för det angivna AAD-programmet.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		En explicit hanterad identitet som ska användas för den här krypteringsnyckeln. Om det inte anges och egenskapen för åtkomstautentiseringsuppgifter är null används den systemtilldelade hanterade identiteten. Om den explicita identiteten är ospecificerad vid uppdatering av resursen förblir den oförändrad. Om "ingen" anges rensas värdet för den här egenskapen.
isServiceLevelKey	boolean	False	Ett valfritt värde som anger om denna nyckel är en servicenivånyckel. Standardvärdet är false.
keyVaultKeyName	string		Namnet på din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data.
keyVaultKeyVersion	string		Den version av Azure Key Vault-nyckeln som ska användas för att kryptera dina vilande data.
keyVaultUri	string		URI:n för ditt Azure Key Vault, även kallat DNS-namn, som innehåller nyckeln som ska användas för att kryptera dina data i vila. Ett exempel på en URI kan vara `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objekt

Representerar en synonymmappningsdefinition.

Name	Typ	Description
@odata.etag	string	ETag för synonymkartan.
encryptionKey	SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Denna nyckel används för att ge en extra nivå av kryptering i vila för dina data när du vill ha full säkerhet att ingen, inte ens Microsoft, kan dekryptera dina data. När du har krypterat dina data förblir de alltid krypterade. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Dina data påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
format	enum: solr	Formatet för synonymmappningen. Endast "solr"-formatet stöds för närvarande.
name	string	Namnet på synonymkartan.
synonyms	string	En serie synonymregler i det angivna synonymmappningsformatet. Reglerna måste separeras med nya rader.