Compartir a través de


Synonym Maps - Create Or Update

Crea un nuevo mapa de sinónimos o actualiza un mapa de sinónimos si ya existe.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string

Dirección URL del punto de conexión del servicio de búsqueda.

synonymMapName
path True

string

Nombre del mapa de sinónimos que se va a crear o actualizar.

api-version
query True

string

Versión de api de cliente.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string

uuid

Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

If-Match

string

Define la condición If-Match. La operación solo se realizará si el valor de ETag del servidor coincide con este valor.

If-None-Match

string

Define la condición If-None-Match. La operación solo se realizará si la etiqueta ETag del servidor no coincide con este valor.

Prefer True

string

Para las solicitudes HTTP PUT, indica al servicio que devuelva el recurso creado o actualizado correctamente.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
format True

SynonymMapFormat

Formato del mapa de sinónimos. Actualmente solo se admite el formato "solr".

name True

string

Nombre del mapa de sinónimos.

synonyms True

string

Una serie de reglas de sinónimos en el formato de asignación de sinónimos especificado. Las reglas deben estar separadas por líneas nuevas.

@odata.etag

string

ETag del mapa de sinónimos.

encryptionKey

SearchResourceEncryptionKey

Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para los datos cuando desea asegurarse de que nadie, ni siquiera Microsoft, puede descifrar sus datos confidenciales. Una vez que haya cifrado los datos, siempre permanecerá cifrado. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; Los datos no se verán afectados. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después.

Respuestas

Nombre Tipo Description
200 OK

SynonymMap

201 Created

SynonymMap

Other Status Codes

SearchError

Respuesta de error.

Ejemplos

SearchServiceCreateOrUpdateSynonymMap

Solicitud de ejemplo

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


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

Respuesta de muestra

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

Definiciones

Nombre Description
AzureActiveDirectoryApplicationCredentials

Credenciales de una aplicación registrada creada para el servicio de búsqueda, que se usa para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault.

SearchError

Describe una condición de error para la API.

SearchResourceEncryptionKey

Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que cree y administre se pueden usar para cifrar o descifrar datos en reposo en el servicio de búsqueda, como índices y mapas de sinónimos.

SynonymMap

Representa una definición de mapa de sinónimos.

SynonymMapFormat

Formato del mapa de sinónimos. Actualmente solo se admite el formato "solr".

AzureActiveDirectoryApplicationCredentials

Credenciales de una aplicación registrada creada para el servicio de búsqueda, que se usa para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault.

Nombre Tipo Description
applicationId

string

Un identificador de aplicación de AAD al que se concedieron los permisos de acceso necesarios a la Key Vault de Azure que se va a usar al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el id. de objeto de la aplicación de AAD.

applicationSecret

string

Clave de autenticación de la aplicación de AAD especificada.

SearchError

Describe una condición de error para la API.

Nombre Tipo Description
code

string

Uno de los conjuntos de códigos de error definidos por el servidor.

details

SearchError[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.

message

string

Representación legible del error.

SearchResourceEncryptionKey

Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que cree y administre se pueden usar para cifrar o descifrar datos en reposo en el servicio de búsqueda, como índices y mapas de sinónimos.

Nombre Tipo Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Credenciales opcionales de Azure Active Directory que se usan para acceder a la Key Vault de Azure. No es necesario si se usa la identidad administrada en su lugar.

keyVaultKeyName

string

Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.

keyVaultKeyVersion

string

La versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.

keyVaultUri

string

El URI de la Key Vault de Azure, también denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un identificador URI de ejemplo podría ser https://my-keyvault-name.vault.azure.net.

SynonymMap

Representa una definición de mapa de sinónimos.

Nombre Tipo Description
@odata.etag

string

ETag del mapa de sinónimos.

encryptionKey

SearchResourceEncryptionKey

Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para los datos cuando desea asegurarse de que nadie, ni siquiera Microsoft, puede descifrar sus datos confidenciales. Una vez que haya cifrado los datos, siempre permanecerá cifrado. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; Los datos no se verán afectados. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después.

format

SynonymMapFormat

Formato del mapa de sinónimos. Actualmente solo se admite el formato "solr".

name

string

Nombre del mapa de sinónimos.

synonyms

string

Una serie de reglas de sinónimos en el formato de asignación de sinónimos especificado. Las reglas deben estar separadas por líneas nuevas.

SynonymMapFormat

Formato del mapa de sinónimos. Actualmente solo se admite el formato "solr".

Nombre Tipo Description
solr

string

Selecciona el formato SOLR para asignaciones de sinónimos.