Synonym Maps - Create Or Update

Referencia

Servicio:: Search Service

Versión de la API:: 2024-07-01

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

PUT {endpoint}/synonymmaps('{synonymMapName}')?api-version=2024-07-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 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 ETag del servidor no coincide con este valor.
Prefer	True	string	En el caso de las solicitudes HTTP PUT, indica al servicio que devuelva el recurso creado o actualizado si se ha realizado 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 mapa 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, pueda descifrar los datos. 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	ErrorResponse	Respuesta de error.

Ejemplos

SearchServiceCreateOrUpdateSynonymMap

Solicitud de ejemplo

HTTP

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

status code:: 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
  }
}

status code:: 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
  }
}

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.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de 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, 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 Azure Key Vault 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.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de 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, como índices y mapas de sinónimos.

Nombre	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciales opcionales de Azure Active Directory que se usan para acceder a Azure Key Vault. 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	Versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.
keyVaultUri	string	El URI de Azure Key Vault, también denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un 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, pueda descifrar los datos. 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 mapa 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 los mapas de sinónimos.

Compartir a través de