Synonym Maps - List
Listen alle Synonymzuordnungen, die für einen Suchdienst verfügbar sind.
GET {endpoint}/synonymmaps?api-version=2023-11-01
GET {endpoint}/synonymmaps?$select={$select}&api-version=2023-11-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 der Synonymzuordnungen abgerufen werden sollen. Wird als durch Trennzeichen getrennte Liste von JSON-Eigenschaftennamen oder |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Die Tracking-ID, die mit der Anforderung gesendet wurde, beim Debuggen zu helfen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK | ||
Other Status Codes |
Fehlerantwort. |
Beispiele
SearchServiceListSynonymMaps
Beispielanforderung
GET https://myservice.search.windows.net/synonymmaps?api-version=2023-11-01
Beispiel für eine Antwort
{
"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 |
---|---|
Azure |
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. |
List |
Antwort aus einer List SynonymMaps-Anforderung. Bei erfolgreicher Ausführung enthält es die vollständigen Definitionen aller Synonymzuordnungen. |
Search |
Beschreibt eine Fehlerbedingung für die API. |
Search |
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 in Ihrem Suchdienst verwendet werden, z. B. Indizes und Synonymzuordnungen. |
Synonym |
Stellt eine Synonymzuordnungsdefinition dar. |
Synonym |
Das Format der Synonymzuordnung. Nur das "solr"-Format wird derzeit unterstützt. |
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.
Name | Typ | Beschreibung |
---|---|---|
applicationId |
string |
Eine AAD-Anwendungs-ID, der die erforderlichen Zugriffsberechtigungen für die Azure-Key Vault erteilt wurde, die beim Verschlüsseln Ihrer ruhenden 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. |
ListSynonymMapsResult
Antwort aus einer List SynonymMaps-Anforderung. Bei erfolgreicher Ausführung enthält es die vollständigen Definitionen aller Synonymzuordnungen.
Name | Typ | Beschreibung |
---|---|---|
value |
Die Synonymzuordnungen im Suchdienst. |
SearchError
Beschreibt eine Fehlerbedingung für die API.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Einer der vom Server definierten Fehlercodes. |
details |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
message |
string |
Eine für Menschen lesbare Darstellung des Fehlers. |
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 in Ihrem Suchdienst verwendet werden, z. B. Indizes und Synonymzuordnungen.
Name | Typ | Beschreibung |
---|---|---|
accessCredentials |
Optionale Azure Active Directory-Anmeldeinformationen, die für den Zugriff auf Ihre Azure Key Vault verwendet werden. Nicht erforderlich, wenn stattdessen eine verwaltete Identität verwendet wird. |
|
keyVaultKeyName |
string |
Der Name Ihres Azure Key Vault Schlüssel, der zum Verschlüsseln ruhender Daten verwendet werden soll. |
keyVaultKeyVersion |
string |
Die Version Ihres Azure Key Vault Schlüssels, der zum Verschlüsseln Ruhezustandsdaten 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 Ruhezustandsdaten verwendet werden soll. Ein Beispiel-URI kann sein |
SynonymMap
Stellt eine Synonymzuordnungsdefinition dar.
Name | Typ | Beschreibung |
---|---|---|
@odata.etag |
string |
Das ETag der Synonymzuordnung. |
encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um ein zusätzliches Maß an Verschlüsselung ruhender Daten für Ihre Daten bereitzustellen, wenn Sie die volle Sicherheit haben möchten, dass niemand, nicht einmal Microsoft, Ihre vertraulichen 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 bei Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Daten bleiben unberührt. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
format |
Das Format der Synonymzuordnung. Nur das "solr"-Format wird derzeit unterstützt. |
|
name |
string |
Der Name der Synonymzuordnung. |
synonyms |
string |
Eine Reihe von Synonymregeln im angegebenen Synonymzuordnungsformat. Die Regeln müssen durch neue Linien getrennt werden. |
SynonymMapFormat
Das Format der Synonymzuordnung. Nur das "solr"-Format wird derzeit unterstützt.
Name | Typ | Beschreibung |
---|---|---|
solr |
string |
Wählt das SOLR-Format für Synonymzuordnungen aus. |