Synonym Maps - Get

Serviço:: Search Service

Versão da API:: 2026-08-01-preview

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

GET {endpoint}/synonymmaps('{synonymMapName}')?api-version=2026-08-01-preview

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
synonymMapName	path	True	string	O nome do mapa de sinônimos.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Name	Tipo	Descrição
200 OK	SynonymMap	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name	Descrição
https://search.azure.com/.default

Exemplos

SearchServiceGetSynonymMap

Pedido de amostra

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/synonymmaps('mysynonymmap')?api-version=2026-08-01-preview

Resposta da amostra

Código de estado:: 200

{
  "@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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definições

Name	Descrição
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)
SearchIndexerDataNoneIdentity	Limpa a propriedade identity de uma fonte de dados.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade a ser usada por uma fonte de dados.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Cofre de Chaves do Azure. 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 de sinônimo.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Descrição
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Descrição
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
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 alvo do erro.

ErrorResponse

Object

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

SearchIndexerDataNoneIdentity

Object

Limpa a propriedade identity de uma fonte de dados.

Name	Tipo	Descrição
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Object

Especifica a identidade a ser usada por uma fonte de dados.

Name	Tipo	Descrição
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI especificando o tipo de identidade.
federatedIdentityClientId	string	Multi-tenant User-Assigned Managed Identity Support: O id do cliente da aplicação multi-tentant que foi configurada para federar com a identidade gerida atribuída pelo utilizador.
userAssignedIdentity	string	A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchResourceEncryptionKey

Object

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

Name	Tipo	Valor predefinido	Descrição
accessCredentials.applicationId	string		Uma ID de Aplicativo AAD que recebeu as permissões de acesso necessárias ao Cofre da Chave do Azure que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto do seu aplicativo AAD.
accessCredentials.applicationSecret	string		A chave de autenticação do aplicativo AAD especificado.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída ao sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo.
isServiceLevelKey	boolean	False	Um valor opcional que indica se esta chave é uma chave de nível de serviço. O valor padrão é falso.
keyVaultKeyName	string		O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string		A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultUri	string		O URI do seu Cofre da Chave do Azure, 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

Object

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

Name	Tipo	Descrição
@odata.etag	string	O ETag do mapa de sinônimos.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para os seus dados quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptar os seus dados. Depois de ter encriptado os seus dados, estes permanecerão sempre encriptados. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Os 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 em ou após 1º de janeiro de 2019.
format	enum: solr	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ônimo no formato de mapa de sinônimo especificado. As regras devem ser separadas por novas linhas.