Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
No Pesquisa de IA do Azure, as chaves de encriptação geridas pelo cliente são criadas, armazenadas e geridas no Azure Key Vault. Se precisar de determinar se um objeto está encriptado, ou que nome ou versão de chave é usada em Azure Key Vault, use a API REST ou um SDK do Azure para recuperar a propriedade encryptionKey da definição do objeto no seu serviço de pesquisa.
Os objetos que não são criptografados com uma chave gerenciada pelo cliente têm uma propriedade encryptionKey vazia. Caso contrário, você poderá ver uma definição semelhante ao exemplo a seguir.
"encryptionKey":{
"keyVaultUri":"https://demokeyvault.vault.azure.net",
"keyVaultKeyName":"myEncryptionKey",
"keyVaultKeyVersion":"eaab6a663d59439ebb95ce2fe7d5f660",
"accessCredentials":{
"applicationId":"00001111-aaaa-2222-bbbb-3333cccc4444",
"applicationSecret":"myApplicationSecret"
}
}
A construção encryptionKey é a mesma para todos os objetos criptografados. É uma propriedade de primeiro nível, no mesmo nível do nome e da descrição do objeto.
Permissões para recuperar definições de objeto
Você deve ter permissões de Colaborador do Serviço de Pesquisa ou equivalente. Para usar a autenticação baseada em chave, forneça uma chave de API de administrador. As permissões de administrador são necessárias em solicitações que retornam definições de objeto e metadados. A forma mais fácil de obter a chave da API de administrador é através do portal do Azure.
Vá ao seu serviço de pesquisa no portal Azure.
No lado esquerdo, selecione Chaves e copie uma API de administração.
Para as etapas restantes, utilize o PowerShell e a API REST. O portal do Azure não mostra a informação da chave de encriptação para nenhum objeto.
Recuperar propriedades do objeto
Use PowerShell e REST para executar os seguintes comandos para configurar as variáveis e obter definições de objeto.
Alternativamente, pode também usar o SDK do Azure para .NET, Python, JavaScript e Java.
Primeiro, ligue-se à sua conta Azure.
Connect-AzAccount
Se tiver mais do que uma subscrição ativa no seu inquilino, especifique a subscrição que contém o seu serviço de pesquisa:
Set-AzContext -Subscription <your-subscription-ID>
Configure os cabeçalhos usados em cada solicitação na sessão atual. Forneça a chave da API admin usada para autenticação do serviço de pesquisa.
$headers = @{
'api-key' = '<YOUR-ADMIN-API-KEY>'
'Content-Type' = 'application/json'
'Accept' = 'application/json' }
Para retornar uma lista de todos os índices de pesquisa, defina o endpoint para a coleção de índices.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/indexes?api-version=2025-09-01&$select=name'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
Para retornar uma definição de índice específica, forneça seu nome no caminho. A propriedade encryptionKey está no final.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/indexes/<YOUR-INDEX-NAME>?api-version=2025-09-01'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
Para retornar mapas de sinônimos, defina o ponto de extremidade para a coleção de sinônimos e envie a solicitação.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/synonyms?api-version=2025-09-01&$select=name'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
O exemplo a seguir retorna uma definição específica de mapa de sinônimos, incluindo a propriedade 'encryptionKey', que está no final da definição.
$uri= 'https://<YOUR-SEARCH-SERVICE>.search.windows.net/synonyms/<YOUR-SYNONYM-MAP-NAME>?api-version=2025-09-01'
Invoke-RestMethod -Uri $uri -Headers $headers | ConvertTo-Json
Use o mesmo padrão para retornar a propriedade encryptionKey para outros objetos de nível superior, como indexadores, conjuntos de habilidades, fontes de dados e aliases de índice.
Próximos passos
Recomendamos que ative o registo no Azure Key Vault para que possa monitorizar o uso das chaves.
Para mais informações sobre a utilização do Azure Key ou a configuração da encriptação gerida pelo cliente: