Synonym Maps - List

Referenz

Dienst:: Search Service

API-Version:: 2024-07-01

Listet alle Synonymzuordnungen auf, die für einen Suchdienst verfügbar sind.

GET {endpoint}/synonymmaps?api-version=2024-07-01

Mit optionalen Parametern:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2024-07-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
api-version	query	True	string	Client-API-Version.
$select	query		string	Wählt aus, welche Eigenschaften der obersten Ebene des Synonyms abgerufen werden sollen. Wird als durch Trennzeichen getrennte Liste von JSON-Eigenschaftsnamen oder '*' für alle Eigenschaften angegeben. Der Standardwert ist alle Eigenschaften.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Tracking-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

Antworten

Name	Typ	Beschreibung
200 OK	ListSynonymMapsResult
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchServiceListSynonymMaps

Beispielanforderung

HTTP

GET https://myservice.search.windows.net/synonymmaps?api-version=2024-07-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "name": "mysynonymmap",
      "format": "solr",
      "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
      "encryptionKey": {
        "keyVaultKeyName": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": null
      }
    },
    {
      "name": "myothersynonymmap",
      "format": "solr",
      "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat",
      "encryptionKey": null
    }
  ]
}

Definitionen

Name	Beschreibung
AzureActiveDirectoryApplicationCredentials	Anmeldeinformationen einer registrierten Anwendung, die für Ihren Suchdienst erstellt wurde und für authentifizierten Zugriff auf die im Azure Key Vault gespeicherten Verschlüsselungsschlüssel verwendet wird.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ListSynonymMapsResult	Antwort von einer List SynonymMaps-Anforderung. Wenn dies erfolgreich ist, enthält sie die vollständigen Definitionen aller Synonymzuordnungen.
SearchResourceEncryptionKey	Ein vom Kunden verwalteter Verschlüsselungsschlüssel im 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

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

Name	Typ	Beschreibung
applicationId	string	Eine AAD-Anwendungs-ID, die die erforderlichen Zugriffsberechtigungen für den Azure Key Vault erteilt hat, die beim Verschlüsseln Ihrer ruhenden Daten verwendet werden sollen. 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

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

ErrorDetail

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

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ListSynonymMapsResult

Antwort von einer List SynonymMaps-Anforderung. Wenn dies erfolgreich ist, enthält sie die vollständigen Definitionen aller Synonymzuordnungen.

Name	Typ	Beschreibung
value	SynonymMap[]	Die Synonymzuordnungen im Suchdienst.

SearchResourceEncryptionKey

Ein vom Kunden verwalteter Verschlüsselungsschlüssel im 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. Ist nicht erforderlich, wenn stattdessen verwaltete Identität verwendet wird.
keyVaultKeyName	string	Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.
keyVaultKeyVersion	string	Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.
keyVaultUri	string	Der URI Ihres Azure Key Vault, auch als DNS-Name bezeichnet, der den Schlüssel enthält, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. Ein Beispiel-URI kann `https://my-keyvault-name.vault.azure.net`sein.

SynonymMap

Stellt eine Synonymzuordnungsdefinition dar.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag der Synonymzuordnung.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Verschlüsselungsstufe für Ihre Daten bereitzustellen, wenn Sie die volle Sicherheit wünschen, dass niemand, nicht einmal Microsoft, Ihre Daten entschlüsseln kann. Sobald Sie Ihre Daten verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf NULL festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie den Verschlüsselungsschlüssel drehen möchten. Ihre Daten sind davon unberührt. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, 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 Synonymzuordnung.
synonyms	string	Eine Reihe von Synonymregeln im angegebenen Synonymzuordnungsformat. Die Regeln müssen durch Neueinleitungen getrennt werden.

SynonymMapFormat

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

Name	Typ	Beschreibung
solr	string	Wählt das SOLR-Format für Synonymzuordnungen aus.

Freigeben über