Synonym Maps - Create Or Update

Dienst:: Search Service

API-Version:: 2025-08-01-preview

Erstellt eine neue Synonymzuordnung oder aktualisiert eine Synonymzuordnung, wenn sie bereits vorhanden ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
synonymMapName	path	True	string	Der Name der Synonymzuordnung, die erstellt oder aktualisiert werden soll.
api-version	query	True	string	Version der Client-API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Die Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen.
If-Match		string	Definiert die If-Match Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server mit diesem Wert übereinstimmt.
If-None-Match		string	Definiert die Bedingung Wenn-None-Match. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.
Prefer	True	string	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
format	True	SynonymMapFormat	Das Format der Synonymzuordnung. Derzeit wird nur das 'solr'-Format unterstützt.
name	True	string	Der Name der Synonymkarte.
synonyms	True	string	Eine Reihe von Synonymregeln im angegebenen Synonymzuordnungsformat. Die Regeln müssen durch Zeilenumbrüche getrennt werden.
@odata.etag		string	Das ETag der Synonym-Map.
encryptionKey		SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Daten bereitzustellen, wenn Sie die vollständige Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, Ihre Daten entschlüsseln kann. Sobald Sie Ihre Daten verschlüsselt haben, bleiben sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Daten bleiben davon unberührt. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, die am oder nach dem 1. Januar 2019 erstellt wurden.

Antworten

Name	Typ	Beschreibung
200 OK	SynonymMap
201 Created	SynonymMap
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchServiceCreateOrUpdateSynonymMap

Beispielanforderung

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"
}

Beispiel für eine Antwort

Statuscode:: 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>"
    }
  }
}

Statuscode:: 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>"
    }
  }
}

Definitionen

Name	Beschreibung
AzureActiveDirectoryApplicationCredentials	Anmeldeinformationen einer registrierten Anwendung, die für Ihren Suchdienst erstellt wurde und für den authentifizierten Zugriff auf die in Azure Key Vault gespeicherten Verschlüsselungsschlüssel verwendet wird.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SearchIndexerDataNoneIdentity	Löscht die Identitätseigenschaft einer Datenquelle.
SearchIndexerDataUserAssignedIdentity	Gibt die Identität an, die von einer Datenquelle verwendet werden soll.
SearchResourceEncryptionKey	Ein kundenseitig verwalteter Verschlüsselungsschlüssel in Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.
SynonymMap	Stellt eine Synonymzuordnungsdefinition dar.
SynonymMapFormat	Das Format der Synonymzuordnung. Derzeit wird nur das 'solr'-Format unterstützt.

AzureActiveDirectoryApplicationCredentials

Objekt

Anmeldeinformationen einer registrierten Anwendung, die für Ihren Suchdienst erstellt wurde und für den authentifizierten Zugriff auf die in Azure Key Vault gespeicherten Verschlüsselungsschlüssel verwendet wird.

Name	Typ	Beschreibung
applicationId	string	Eine AAD-Anwendungs-ID, der die erforderlichen Zugriffsberechtigungen für Azure Key Vault erteilt wurden, die beim Verschlüsseln ruhender Daten verwendet werden soll. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden.
applicationSecret	string	Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SearchIndexerDataNoneIdentity

Objekt

Löscht die Identitätseigenschaft einer Datenquelle.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Ein URI-Fragment, das den Typ der Identität angibt.

SearchIndexerDataUserAssignedIdentity

Objekt

Gibt die Identität an, die von einer Datenquelle verwendet werden soll.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ein URI-Fragment, das den Typ der Identität angibt.
userAssignedIdentity	string	Die vollqualifizierte Azure-Ressourcen-ID einer benutzerseitig zugewiesenen verwalteten Identität, in der Regel im Format "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", die dem Suchdienst hätte zugewiesen werden sollen.

SearchResourceEncryptionKey

Objekt

Ein kundenseitig verwalteter Verschlüsselungsschlüssel in Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.

Name	Typ	Beschreibung
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optionale Azure Active Directory-Anmeldeinformationen, die für den Zugriff auf Ihren Azure Key Vault verwendet werden. Nicht erforderlich, wenn stattdessen eine verwaltete Identität verwendet wird.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn nicht angegeben und die Eigenschaft für die Zugriffsanmeldeinformationen null ist, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität beim Aktualisieren der Ressource nicht angegeben ist, bleibt sie unverändert. Wenn "none" angegeben ist, wird der Wert dieser Eigenschaft gelöscht.
keyVaultKeyName	string	Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln ruhender Daten verwendet werden soll.
keyVaultKeyVersion	string	Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln ruhender Daten verwendet werden soll.
keyVaultUri	string	Der URI Ihres Azure Key Vault-Postfachs, der auch als DNS-Name bezeichnet wird und den Schlüssel enthält, der zum Verschlüsseln ruhender Daten verwendet werden soll. Ein Beispiel-URI könnte sein `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objekt

Stellt eine Synonymzuordnungsdefinition dar.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag der Synonym-Map.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Daten bereitzustellen, wenn Sie die vollständige Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, Ihre Daten entschlüsseln kann. Sobald Sie Ihre Daten verschlüsselt haben, bleiben sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Daten bleiben davon unberührt. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, die am oder nach dem 1. Januar 2019 erstellt wurden.
format	SynonymMapFormat	Das Format der Synonymzuordnung. Derzeit wird nur das 'solr'-Format unterstützt.
name	string	Der Name der Synonymkarte.
synonyms	string	Eine Reihe von Synonymregeln im angegebenen Synonymzuordnungsformat. Die Regeln müssen durch Zeilenumbrüche getrennt werden.

SynonymMapFormat

Enumeration

Das Format der Synonymzuordnung. Derzeit wird nur das 'solr'-Format unterstützt.

Wert	Beschreibung
solr	Wählt das SORR-Format für Synonym-Maps aus.