Synonym Maps - List

Referência

Serviço:: Search Service

Versão da API:: 2023-11-01

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

GET {endpoint}/synonymmaps?api-version=2023-11-01

Com parâmetros opcionais:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2023-11-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 do sinônimo são mapeadas para recuperar. Especificada 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	A ID de rastreamento enviada com a solicitação para ajudar na depuração.

Respostas

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

Exemplos

SearchServiceListSynonymMaps

Solicitação de exemplo

HTTP

GET https://myservice.search.windows.net/synonymmaps?api-version=2023-11-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "mysynonymmap",
      "format": "solr",
      "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
      "encryptionKey": {
        "keyVaultKeyName": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": null
      }
    },
    {
      "name": "myothersynonymmap",
      "format": "solr",
      "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat",
      "encryptionKey": null
    }
  ]
}

Definições

Nome	Description
AzureActiveDirectoryApplicationCredentials	Credenciais de um aplicativo registrado criado para seu serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.
ListSynonymMapsResult	Resposta de uma solicitação List SynonymMaps. Se tiver êxito, ele incluirá as definições completas de todos os mapas de sinônimos.
SearchError	Descreve uma condição de erro para a API.
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 em seu serviço de pesquisa, como índices e mapas de sinônimos.
SynonymMap	Representa uma definição de mapa de sinônimo.
SynonymMapFormat	O formato do mapa de sinônimos. No momento, há suporte apenas para o formato 'solr'.

AzureActiveDirectoryApplicationCredentials

Credenciais de um aplicativo registrado criado para seu 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 para o Key Vault 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 para seu aplicativo do AAD.
applicationSecret	string	A chave de autenticação do aplicativo AAD especificado.

ListSynonymMapsResult

Resposta de uma solicitação List SynonymMaps. Se tiver êxito, 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 Pesquisa.

SearchError

Descreve uma condição de erro para a API.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message	string	Uma representação legível pelo homem do erro.

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 em seu serviço de pesquisa, como índices e mapas de sinônimos.

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

SynonymMap

Representa uma definição de mapa de 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 criada no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quiser ter total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados confidenciais. 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 em ou após 1º de janeiro de 2019.
format	SynonymMapFormat	O formato do mapa de sinônimos. No momento, há suporte apenas para o formato 'solr'.
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.

SynonymMapFormat

O formato do mapa de sinônimos. No momento, há suporte apenas para o formato 'solr'.

Nome	Tipo	Description
solr	string	Seleciona o formato SOLR para mapas de sinônimos.

Compartilhar via