Synonym Maps - Create Or Update

Tjänst:: Search Service

API-version:: 2025-08-01-preview

Skapar en ny synonymmappning eller uppdaterar en synonymmappning om den redan finns.

PUT {endpoint}/synonymmaps('{synonymMapName}')?api-version=2025-08-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
synonymMapName	path	True	string	Namnet på synonymmappningen som ska skapas eller uppdateras.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Spårnings-ID:t som skickades med begäran för att hjälpa till med felsökning.
If-Match		string	Definierar villkoret If-Match. Åtgärden utförs endast om ETag på servern matchar det här värdet.
If-None-Match		string	Definierar villkoret Om-None-Match. Åtgärden utförs endast om ETag på servern inte matchar det här värdet.
Prefer	True	string	För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.

Begärandetext

Name	Obligatorisk	Typ	Description
format	True	SynonymMapFormat	Formatet för synonymmappningen. Endast "solr"-formatet stöds för närvarande.
name	True	string	Namnet på synonymmappningen.
synonyms	True	string	En serie synonymregler i det angivna synonymmappningsformatet. Reglerna måste separeras med nya rader.
@odata.etag		string	ETag för synonymmappningen.
encryptionKey		SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för dina data när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dina data. När du har krypterat dina data kommer de alltid att förbli 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 uppgifter kommer inte att påverkas. 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
200 OK	SynonymMap
201 Created	SynonymMap
Other Status Codes	ErrorResponse	Felsvar.

Exempel

SearchServiceCreateOrUpdateSynonymMap

Exempelbegäran

HTTP

PUT https://previewexampleservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2025-08-01-preview





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

Exempelsvar

Statuskod:: 200

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

Statuskod:: 201

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

Definitioner

Name	Description
AzureActiveDirectoryApplicationCredentials	Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	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 密钥保管库. 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 definition av en synonymmappning.
SynonymMapFormat	Formatet för synonymmappningen. Endast "solr"-formatet stöds för närvarande.

AzureActiveDirectoryApplicationCredentials

Objekt

Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.

Name	Typ	Description
applicationId	string	Ett AAD-program-ID som har beviljats de åtkomstbehörigheter som krävs för att Azure Key Vault ska användas när du krypterar dina vilande data. Program-ID:t ska inte förväxlas med objekt-ID:t för ditt AAD-program.
applicationSecret	string	Autentiseringsnyckeln för det angivna AAD-programmet.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	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

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.
userAssignedIdentity	string	Det fullständigt kvalificerade Azure-resurs-ID:t för en användartilldelad hanterad identitet, vanligtvis i formatet "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" som skulle ha tilldelats till söktjänsten.

SearchResourceEncryptionKey

Objekt

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

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Valfria Azure Active Directory-autentiseringsuppgifter som används för att komma åt din Azure Key Vault. Krävs inte om du använder hanterad identitet i stället.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	En explicit hanterad identitet som ska användas för den här krypteringsnyckeln. Om inget anges och egenskapen för autentiseringsuppgifter för åtkomst är null används den system tilldelade hanterade identiteten. Vid uppdatering av resursen, om den explicita identiteten är ospecificerad, förblir den oförändrad. Om "ingen" anges rensas värdet för den här egenskapen.
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 din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data.
keyVaultUri	string	URI:n för din Azure Key Vault, även kallat DNS-namn, som innehåller nyckeln som ska användas för att kryptera dina vilande data. Ett exempel på en URI kan vara `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objekt

Representerar en definition av en synonymmappning.

Name	Typ	Description
@odata.etag	string	ETag för synonymmappningen.
encryptionKey	SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för dina data när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dina data. När du har krypterat dina data kommer de alltid att förbli 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 uppgifter kommer inte att påverkas. 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	SynonymMapFormat	Formatet för synonymmappningen. Endast "solr"-formatet stöds för närvarande.
name	string	Namnet på synonymmappningen.
synonyms	string	En serie synonymregler i det angivna synonymmappningsformatet. Reglerna måste separeras med nya rader.

SynonymMapFormat

Uppräkning

Formatet för synonymmappningen. Endast "solr"-formatet stöds för närvarande.

Värde	Description
solr	Väljer SOLR-format för synonymmappningar.