Synonym Maps - Create

Servicio:: Search Service

Versión de la API:: 2025-09-01

Crea un nuevo mapa de sinónimos.

POST {endpoint}/synonymmaps?api-version=2025-09-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	La dirección URL del punto de conexión del servicio de búsqueda.
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)	El identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
format	True	SynonymMapFormat	El formato del mapa de sinónimos. Actualmente solo se admite el formato 'solr'.
name	True	string	El 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 nuevas líneas.
@odata.etag		string	La 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 sus datos cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrar sus datos. Una vez que haya cifrado sus datos, siempre permanecerán encriptados. 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 su clave de cifrado; Sus 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 pagos creados a partir del 1 de enero de 2019.

Respuestas

Nombre	Tipo	Description
201 Created	SynonymMap
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

SearchServiceCreateSynonymMap

Solicitud de ejemplo

HTTP

POST https://stableexampleservice.search.windows.net/synonymmaps?api-version=2025-09-01


{
  "name": "tempsynonymmap",
  "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": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempsynonymmap",
  "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": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definiciones

Nombre	Description
AzureActiveDirectoryApplicationCredentials	Credenciales de una aplicación registrada creada para el servicio de búsqueda, usadas 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 crea y administra 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	El formato del mapa de sinónimos. Actualmente solo se admite el formato 'solr'.

AzureActiveDirectoryApplicationCredentials

Objeto

Credenciales de una aplicación registrada creada para el servicio de búsqueda, usadas 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 usará al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el identificador de objeto de la aplicación de AAD.
applicationSecret	string	Clave de autenticación de la aplicación de AAD especificada.

ErrorAdditionalInfo

Objeto

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

Objeto

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	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SearchResourceEncryptionKey

Objeto

Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra 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 usadas 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	La 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 conocido como nombre DNS, que contiene la clave que se usará para cifrar los datos en reposo. Un ejemplo de URI podría ser `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objeto

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

Nombre	Tipo	Description
@odata.etag	string	La 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 sus datos cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrar sus datos. Una vez que haya cifrado sus datos, siempre permanecerán encriptados. 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 su clave de cifrado; Sus 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 pagos creados a partir del 1 de enero de 2019.
format	SynonymMapFormat	El formato del mapa de sinónimos. Actualmente solo se admite el formato 'solr'.
name	string	El 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 nuevas líneas.

SynonymMapFormat

Enumeración

El formato del mapa de sinónimos. Actualmente solo se admite el formato 'solr'.

Valor	Description
solr	Selecciona el formato SOLR para los mapas de sinónimos.

Compartir a través de

Synonym Maps - Create

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Ejemplos

SearchServiceCreateSynonymMap

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureActiveDirectoryApplicationCredentials

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SearchResourceEncryptionKey

SynonymMap

SynonymMapFormat