Synonym Maps - Create

Referência

Serviço:: Search Service

Versão da API:: 2024-05-01-preview

Cria um novo mapa de sinónimos.

POST {endpoint}/synonymmaps?api-version=2024-05-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

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

Corpo do Pedido

Name	Necessário	Tipo	Description
format	True	SynonymMapFormat	O formato do mapa de sinónimos. Apenas o formato "solr" é atualmente suportado.
name	True	string	O nome do mapa de sinónimos.
synonyms	True	string	Uma série de regras de sinónimo no formato de mapa de sinónimos especificado. As regras têm de ser separadas por novas linhas.
@odata.etag		string	O ETag do mapa de sinónimos.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de encriptação que cria no Azure Key Vault. Esta chave é utilizada para fornecer um nível adicional de encriptação inativa para os seus dados quando quiser ter a garantia total de que ninguém, nem mesmo a Microsoft, pode desencriptar os seus dados. Depois de encriptar os seus dados, estes permanecerão sempre encriptados. O serviço de pesquisa irá ignorar as tentativas de definir esta propriedade como nula. Pode alterar esta propriedade conforme necessário se quiser rodar a chave de encriptação; Os seus dados não serão afetados. A encriptação com chaves geridas pelo cliente não está disponível para serviços de pesquisa gratuita e só está disponível para serviços pagos criados em ou depois de 1 de janeiro de 2019.

Respostas

Name	Tipo	Description
201 Created	SynonymMap
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceCreateSynonymMap

Pedido de amostra

HTTP

POST https://myservice.search.windows.net/synonymmaps?api-version=2024-05-01-preview

{
  "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": "myApplicationSecret"
    }
  }
}

Resposta da amostra

Código de estado:: 201

{
  "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": null
    }
  }
}

Definições

Name	Description
AzureActiveDirectoryApplicationCredentials	Credenciais de uma aplicação registada criada para o seu serviço de pesquisa, utilizada para acesso autenticado às chaves de encriptação armazenadas no Azure Key Vault.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
SearchIndexerDataNoneIdentity	Limpa a propriedade de identidade de uma origem de dados.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade de uma origem de dados a utilizar.
SearchResourceEncryptionKey	Uma chave de encriptação gerida pelo cliente no Azure Key Vault. As chaves que criar e gerir podem ser utilizadas para encriptar ou desencriptar dados inativos, como índices e mapas de sinónimos.
SynonymMap	Representa uma definição de mapa de sinónimos.
SynonymMapFormat	O formato do mapa de sinónimos. Apenas o formato "solr" é atualmente suportado.

AzureActiveDirectoryApplicationCredentials

Credenciais de uma aplicação registada criada para o seu serviço de pesquisa, utilizada para acesso autenticado às chaves de encriptação armazenadas no Azure Key Vault.

Name	Tipo	Description
applicationId	string	Um ID da Aplicação do AAD a quem foram concedidas as permissões de acesso necessárias para o Azure Key Vault que deve ser utilizado ao encriptar os seus dados inativos. O ID da Aplicação não deve ser confundido com o ID do Objeto da sua Aplicação do AAD.
applicationSecret	string	A chave de autenticação da aplicação do AAD especificada.

ErrorAdditionalInfo

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

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[]	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

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

SearchIndexerDataNoneIdentity

Limpa a propriedade de identidade de uma origem de dados.

Name	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Um fragmento de URI que especifica o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Especifica a identidade de uma origem de dados a utilizar.

Name	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI que especifica o tipo de identidade.
userAssignedIdentity	string	O ID de recurso completamente qualificado do Azure de um utilizador atribuído identidade gerida normalmente no formulário "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuído ao serviço de pesquisa.

SearchResourceEncryptionKey

Uma chave de encriptação gerida pelo cliente no Azure Key Vault. As chaves que criar e gerir podem ser utilizadas para encriptar ou desencriptar dados inativos, como índices e mapas de sinónimos.

Name	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciais opcionais do Azure Active Directory utilizadas para aceder ao seu Key Vault do Azure. Em vez disso, não é necessário utilizar a identidade gerida.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Uma identidade gerida explícita a utilizar para esta chave de encriptação. Se não for especificado e a propriedade de credenciais de acesso for nula, é utilizada a identidade gerida atribuída pelo sistema. Ao atualizar para o recurso, se a identidade explícita não for especificada, permanece inalterada. Se "nenhum" for especificado, o valor desta propriedade será limpo.
keyVaultKeyName	string	O nome da sua chave de Key Vault do Azure a ser utilizada para encriptar os seus dados inativos.
keyVaultKeyVersion	string	A versão da sua chave de Key Vault do Azure a ser utilizada para encriptar os seus dados inativos.
keyVaultUri	string	O URI do seu Key Vault do Azure, também conhecido como nome DNS, que contém a chave a ser utilizada para encriptar os 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ónimos.

Name	Tipo	Description
@odata.etag	string	O ETag do mapa de sinónimos.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de encriptação que cria no Azure Key Vault. Esta chave é utilizada para fornecer um nível adicional de encriptação inativa para os seus dados quando quiser ter a garantia total de que ninguém, nem mesmo a Microsoft, pode desencriptar os seus dados. Depois de encriptar os seus dados, estes permanecerão sempre encriptados. O serviço de pesquisa irá ignorar as tentativas de definir esta propriedade como nula. Pode alterar esta propriedade conforme necessário se quiser rodar a chave de encriptação; Os seus dados não serão afetados. A encriptação com chaves geridas pelo cliente não está disponível para serviços de pesquisa gratuita e só está disponível para serviços pagos criados em ou depois de 1 de janeiro de 2019.
format	SynonymMapFormat	O formato do mapa de sinónimos. Apenas o formato "solr" é atualmente 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ónimos especificado. As regras têm de ser separadas por novas linhas.

SynonymMapFormat

O formato do mapa de sinónimos. Apenas o formato "solr" é atualmente suportado.

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

Partilhar via