Synonym Maps - Get

Service:: Search Service

Version d'API:: 2023-11-01

Récupère une définition de carte de synonymes.

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2023-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
synonymMapName	path	True	string	Nom de la carte de synonymes à récupérer.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	ID de suivi envoyé avec la demande pour faciliter le débogage.

Réponses

Nom	Type	Description
200 OK	SynonymMap
Other Status Codes	SearchError	Réponse d’erreur.

Exemples

SearchServiceGetSynonymMap

Exemple de requête

HTTP

GET https://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2023-11-01

Exemple de réponse

Code d’état:: 200

{
  "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": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

Définitions

Nom	Description
AzureActiveDirectoryApplicationCredentials	Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.
SearchError	Décrit une condition d’erreur pour l’API.
SearchResourceEncryptionKey	Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos sur votre service de recherche, telles que des index et des mappages de synonymes.
SynonymMap	Représente une définition de carte de synonymes.
SynonymMapFormat	Format de la carte de synonymes. Seul le format « solr » est actuellement pris en charge.

AzureActiveDirectoryApplicationCredentials

Objet

Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.

Nom	Type	Description
applicationId	string	ID d’application AAD qui a reçu les autorisations d’accès requises au coffre de clés Azure à utiliser lors du chiffrement de vos données au repos. L’ID d’application ne doit pas être confondu avec l’ID d’objet de votre application AAD.
applicationSecret	string	Clé d’authentification de l’application AAD spécifiée.

SearchError

Objet

Décrit une condition d’erreur pour l’API.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	SearchError[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
message	string	Représentation lisible par l’homme de l’erreur.

SearchResourceEncryptionKey

Objet

Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos sur votre service de recherche, telles que des index et des mappages de synonymes.

Nom	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Informations d’identification Azure Active Directory facultatives utilisées pour accéder à votre coffre de clés Azure. Non obligatoire si vous utilisez plutôt une identité managée.
keyVaultKeyName	string	Nom de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.
keyVaultKeyVersion	string	Version de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.
keyVaultUri	string	URI de votre coffre de clés Azure, également appelé nom DNS, qui contient la clé à utiliser pour chiffrer vos données au repos. Un exemple d’URI peut être `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objet

Représente une définition de carte de synonymes.

Nom	Type	Description
@odata.etag	string	ETag de la carte de synonymes.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour vos données lorsque vous souhaitez une assurance totale que personne, même Microsoft, ne peut déchiffrer vos données sensibles. Une fois que vous avez chiffré vos données, elles restent toujours chiffrées. Le service de recherche ignore les tentatives de définition de cette propriété sur Null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; Vos données ne seront pas affectées. Le chiffrement avec des clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés le 1er janvier 2019.
format	SynonymMapFormat	Format de la carte de synonymes. Seul le format « solr » est actuellement pris en charge.
name	string	Nom de la carte de synonymes.
synonyms	string	Série de règles de synonymes au format de carte de synonymes spécifié. Les règles doivent être séparées par des lignes nouvelles.

SynonymMapFormat

Énumération

Format de la carte de synonymes. Seul le format « solr » est actuellement pris en charge.

Valeur	Description
solr	Sélectionne le format SOLR pour les mappages de synonymes.