Synonym Maps - Get

Référence

Service:: Search Service

Version d'API:: 2024-05-01-preview

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

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2024-05-01-preview

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 du mappage 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	ErrorResponse	Réponse d’erreur.

Exemples

SearchServiceGetSynonymMap

Exemple de requête

HTTP

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

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ées pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
SearchIndexerDataNoneIdentity	Efface la propriété identity d’une source de données.
SearchIndexerDataUserAssignedIdentity	Spécifie l’identité d’une source de données à utiliser.
SearchResourceEncryptionKey	Une 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 les données au repos, telles que les index et les 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

Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisées 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 disposant des autorisations d’accès requises à l’Key Vault 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.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

SearchIndexerDataNoneIdentity

Efface la propriété identity d’une source de données.

Nom	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment d’URI spécifiant le type d’identité.

SearchIndexerDataUserAssignedIdentity

Spécifie l’identité d’une source de données à utiliser.

Nom	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment d’URI spécifiant le type d’identité.
userAssignedIdentity	string	Id de ressource Azure complet d’une identité managée affectée par l’utilisateur généralement sous la forme « /subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId » qui aurait dû être affecté au service de recherche.

SearchResourceEncryptionKey

Une 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 les données au repos, telles que les index et les mappages de synonymes.

Nom	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Informations d’identification Azure Active Directory facultatives utilisées pour accéder à votre Key Vault Azure. Non obligatoire si vous utilisez une identité managée à la place.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identité managée explicite à utiliser pour cette clé de chiffrement. Si elle n’est pas spécifiée et que la propriété des informations d’identification d’accès est null, l’identité managée affectée par le système est utilisée. Lors de la mise à jour de la ressource, si l’identité explicite n’est pas spécifiée, elle reste inchangée. Si « none » est spécifié, la valeur de cette propriété est effacée.
keyVaultKeyName	string	Nom de votre clé de Key Vault Azure à utiliser pour chiffrer vos données au repos.
keyVaultKeyVersion	string	La version de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.
keyVaultUri	string	URI de votre Key Vault Azure, également appelé nom DNS, qui contient la clé à utiliser pour chiffrer vos données au repos. Un exemple d’URI pourrait être `https://my-keyvault-name.vault.azure.net`.

SynonymMap

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 avoir l’assurance que personne, pas même Microsoft, ne peut déchiffrer vos données. 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 est uniquement disponible pour les services payants créés à partir du 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

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

Nom	Type	Description
solr	string	Sélectionne le format SOLR pour les mappages de synonymes.

Partager via