Synonym Maps - List

Referência

Serviço:: Search Service

Versão da API:: 2024-07-01

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

GET {endpoint}/synonymmaps?api-version=2024-07-01

Com parâmetros opcionais:

GET {endpoint}/synonymmaps?$select={$select}&api-version=2024-07-01

Parâmetros do URI

Name	Em	Necessá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. 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 do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de rastreamento enviado com a solicitação para ajudar com a depuração.

Respostas

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

Exemplos

SearchServiceListSynonymMaps

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
AzureActiveDirectoryApplicationCredentials	Credenciais de um aplicativo registrado criado para seu serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Cofre de Chaves do Azure.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ListSynonymMapsResult	Resposta de uma solicitação List SynonymMaps. Se for bem sucedido, inclui as definições completas de todos os mapas de sinónimos.
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.
SynonymMapFormat	O formato do mapa de sinônimos. Atualmente, apenas o formato 'solr' é suportado.

AzureActiveDirectoryApplicationCredentials

Credenciais de um aplicativo registrado criado para seu serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Cofre de Chaves do Azure.

Name	Tipo	Description
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.
applicationSecret	string	A chave de autenticação do aplicativo AAD especificado.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ListSynonymMapsResult

Resposta de uma solicitação List SynonymMaps. Se for bem sucedido, inclui as definições completas de todos os mapas de sinónimos.

Name	Tipo	Description
value	SynonymMap[]	O sinónimo mapeia no serviço de Pesquisa.

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.

Name	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciais opcionais do Azure Ative Directory usadas para acessar seu Cofre da Chave do Azure. Não é necessário se estiver usando a identidade gerenciada.
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

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

Name	Tipo	Description
@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. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quiser garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar 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	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ô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. Atualmente, apenas o formato 'solr' é suportado.

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

Partilhar via