Synonym Maps - List

Serviço:: Search Service

Versão da API:: 2025-09-01

Lista todos os mapas de sinônimos disponíveis para um serviço de pesquisa.

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

Com parâmetros opcionais:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2025-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string	Versão da API do cliente.
$select	query		string	Seleciona quais propriedades de nível superior dos mapas de sinônimos devem ser recuperadas. Especificado como uma lista separada por vírgulas de nomes de propriedade JSON ou '*' para todas as propriedades. O padrão é todas as propriedades.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	O ID de rastreamento enviado com a solicitação para ajudar na depuração.

Respostas

Nome	Tipo	Description
200 OK	ListSynonymMapsResult
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceListSynonymMaps

Solicitação de exemplo

HTTP

GET https://stableexampleservice.search.windows.net/synonymmaps?$select=&api-version=2025-09-01

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
AzureActiveDirectoryApplicationCredentials	Credenciais de um aplicativo registrado criado para o serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ListSynonymMapsResult	Resposta de uma solicitação List SynonymMaps. Se for bem-sucedido, ele incluirá as definições completas de todos os mapas de sinônimos.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.
SynonymMap	Representa uma definição de mapa sinônimo.
SynonymMapFormat	O formato do mapa de sinônimos. Atualmente, apenas o formato 'solr' é suportado.

AzureActiveDirectoryApplicationCredentials

Objeto

Credenciais de um aplicativo registrado criado para o serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.

Nome	Tipo	Description
applicationId	string	Uma ID de Aplicativo do AAD que recebeu as permissões de acesso necessárias ao Azure Key Vault que deve ser usado ao criptografar seus dados em repouso. A ID do Aplicativo não deve ser confundida com a ID do Objeto do Aplicativo AAD.
applicationSecret	string	A chave de autenticação do aplicativo AAD especificado.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ListSynonymMapsResult

Objeto

Resposta de uma solicitação List SynonymMaps. Se for bem-sucedido, ele incluirá as definições completas de todos os mapas de sinônimos.

Nome	Tipo	Description
value	SynonymMap[]	O sinônimo é mapeado no serviço de Pesquisa.

SearchResourceEncryptionKey

Objeto

Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

Nome	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciais opcionais do Azure Active Directory usadas para acessar o Azure Key Vault. Não é necessário se estiver usando a identidade gerenciada.
keyVaultKeyName	string	O nome da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string	A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultUri	string	O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objeto

Representa uma definição de mapa sinônimo.

Nome	Tipo	Description
@odata.etag	string	A ETag do mapa de sinônimos.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você deseja garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados. Depois de criptografar seus dados, eles sempre permanecerão criptografados. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Seus dados não serão afetados. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados a partir de 1º de janeiro de 2019.
format	SynonymMapFormat	O formato do mapa de sinônimos. Atualmente, apenas o formato 'solr' é suportado.
name	string	O nome do mapa de sinônimos.
synonyms	string	Uma série de regras de sinônimos no formato de mapa de sinônimos especificado. As regras devem ser separadas por novas linhas.

SynonymMapFormat

Enumeração

O formato do mapa de sinônimos. Atualmente, apenas o formato 'solr' é suportado.

Valor	Description
solr	Seleciona o formato SOLR para mapas de sinônimos.