Synonym Maps - Create Or Update

Riferimento

Servizio:: Search Service

Versione API:: 2024-05-01-preview

Crea una nuova mappa sinonimo o aggiorna una mappa sinonimo se esiste già.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
synonymMapName	path	True	string	Nome della mappa sinonimo per creare o aggiornare.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string uuid	ID di rilevamento inviato con la richiesta di assistenza per il debug.
If-Match		string	Definisce la condizione di If-Match. L'operazione verrà eseguita solo se il ETag nel server corrisponde a questo valore.
If-None-Match		string	Definisce la condizione If-None-Match. L'operazione verrà eseguita solo se L'ETag nel server non corrisponde a questo valore.
Prefer	True	string	Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
format	True	SynonymMapFormat	Formato della mappa sinonimia. Attualmente è supportato solo il formato "solr".
name	True	string	Nome della mappa sinonimia.
synonyms	True	string	Serie di regole di sinonimo nel formato mappa sinonimo specificato. Le regole devono essere separate da nuove linee.
@odata.etag		string	ETag della mappa sinonimo.
encryptionKey		SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia inattivi per i dati quando si vuole garantire che nessuno, non anche Microsoft, possa decrittografare i dati. Dopo aver crittografato i dati, rimarrà sempre crittografato. Il servizio di ricerca ignora i tentativi di impostare questa proprietà su Null. È possibile modificare questa proprietà in base alle esigenze se si vuole ruotare la chiave di crittografia; I dati non saranno interessati. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati o dopo il 1° gennaio 2019.

Risposte

Nome	Tipo	Descrizione
200 OK	SynonymMap
201 Created	SynonymMap
Other Status Codes	ErrorResponse	Risposta di errore.

Esempio

SearchServiceCreateOrUpdateSynonymMap

Esempio di richiesta

HTTP

PUT https://myservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2024-05-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": null
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "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": null
  }
}

Codice di stato:: 201

{
  "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": null
  }
}

Definizioni

Nome	Descrizione
AzureActiveDirectoryApplicationCredentials	Credenziali di un'applicazione registrata creata per il servizio di ricerca, usata per l'accesso autenticato alle chiavi di crittografia archiviate in Azure Key Vault.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
SearchIndexerDataNoneIdentity	Cancella la proprietà identity di un'origine dati.
SearchIndexerDataUserAssignedIdentity	Specifica l'identità da usare per un'origine dati.
SearchResourceEncryptionKey	Chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite possono essere usate per crittografare o decrittografare i dati inattivi, ad esempio indici e mappe sinonimie.
SynonymMap	Rappresenta una definizione della mappa sinonimo.
SynonymMapFormat	Formato della mappa sinonimia. Attualmente è supportato solo il formato "solr".

AzureActiveDirectoryApplicationCredentials

Credenziali di un'applicazione registrata creata per il servizio di ricerca, usata per l'accesso autenticato alle chiavi di crittografia archiviate in Azure Key Vault.

Nome	Tipo	Descrizione
applicationId	string	ID applicazione AAD che ha concesso le autorizzazioni di accesso necessarie all'Key Vault di Azure da usare durante la crittografia dei dati inattivi. L'ID applicazione non deve essere confuso con l'ID oggetto per l'applicazione AAD.
applicationSecret	string	Chiave di autenticazione dell'applicazione AAD specificata.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

SearchIndexerDataNoneIdentity

Cancella la proprietà identity di un'origine dati.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Frammento URI che specifica il tipo di identità.

SearchIndexerDataUserAssignedIdentity

Specifica l'identità da usare per un'origine dati.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Frammento URI che specifica il tipo di identità.
userAssignedIdentity	string	ID risorsa di Azure completo di un'identità gestita assegnata dall'utente in genere nel formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" che deve essere stato assegnato al servizio di ricerca.

SearchResourceEncryptionKey

Chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite possono essere usate per crittografare o decrittografare i dati inattivi, ad esempio indici e mappe sinonimie.

Nome	Tipo	Descrizione
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenziali facoltative di Azure Active Directory usate per accedere all'Key Vault di Azure. Non richiesto se si usa invece l'identità gestita.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identità gestita esplicita da usare per questa chiave di crittografia. Se non specificato e la proprietà delle credenziali di accesso è Null, viene usata l'identità gestita assegnata dal sistema. Se l'identità esplicita non è specificata, l'aggiornamento alla risorsa rimane invariato. Se viene specificato "nessuno", il valore di questa proprietà viene cancellato.
keyVaultKeyName	string	Nome della chiave di Key Vault di Azure da usare per crittografare i dati inattivi.
keyVaultKeyVersion	string	Versione della chiave di Key Vault di Azure da usare per crittografare i dati inattivi.
keyVaultUri	string	URI dell'Key Vault di Azure, noto anche come nome DNS, che contiene la chiave da usare per crittografare i dati inattivi. Un URI di esempio potrebbe essere `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Rappresenta una definizione della mappa sinonimo.

Nome	Tipo	Descrizione
@odata.etag	string	ETag della mappa sinonimo.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia inattivi per i dati quando si vuole garantire che nessuno, non anche Microsoft, possa decrittografare i dati. Dopo aver crittografato i dati, rimarrà sempre crittografato. Il servizio di ricerca ignora i tentativi di impostare questa proprietà su Null. È possibile modificare questa proprietà in base alle esigenze se si vuole ruotare la chiave di crittografia; I dati non saranno interessati. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati o dopo il 1° gennaio 2019.
format	SynonymMapFormat	Formato della mappa sinonimia. Attualmente è supportato solo il formato "solr".
name	string	Nome della mappa sinonimia.
synonyms	string	Serie di regole di sinonimo nel formato mappa sinonimo specificato. Le regole devono essere separate da nuove linee.

SynonymMapFormat

Formato della mappa sinonimia. Attualmente è supportato solo il formato "solr".

Nome	Tipo	Descrizione
solr	string	Seleziona il formato SOLR per le mappe sinonimi.

Condividi tramite