biblioteca de clientes do Monitoramento do Azure Synapse Analytics para .NET – versão 1.0.0-beta.3

Artigo
04/21/2023

Esse diretório contém o subconjunto código aberto do SDK do .NET. Para obter a documentação do SDK completo do Azure, consulte o Centro de Desenvolvedores do Microsoft Azure .NET.

O Azure Synapse Analytics oferece uma rica experiência de monitoramento no portal do Azure para gerar insights sobre a carga de trabalho do data warehouse. A biblioteca de clientes de monitoramento do Azure Synapse Analytics permite monitorar programaticamente seus recursos.

O Azure Synapse é um serviço de análise ilimitado que reúne data warehouse empresarial e análise de Big Data. Ele oferece a liberdade para consultar dados da forma que você quiser, usando recursos sob demanda sem servidor ou provisionados em escala. O Azure Synapse conecta esses dois mundos com uma experiência unificada para ingerir, preparar, gerenciar e fornecer dados para necessidades imediatas de BI e de aprendizado de máquina.

Introdução

O SDK completo do Microsoft Azure pode ser baixado da Página de Downloads do Microsoft Azure e é fornecido com suporte para a criação de pacotes de implantação, integração com ferramentas, ferramentas avançadas de linha de comando e muito mais.

Para obter a melhor experiência de desenvolvimento, os desenvolvedores devem usar os pacotes oficiais do Microsoft NuGet para bibliotecas. Os pacotes NuGet são atualizados regularmente com novas funcionalidades e hotfixes.

Instalar o pacote

Instale a biblioteca de clientes de monitoramento do Azure Synapse Analytics para .NET com o NuGet:

dotnet add package Azure.Analytics.Synapse.Monitoring --version 1.0.0-preview.1

Pré-requisitos

Assinatura do Azure: Para usar os serviços do Azure, incluindo Azure Synapse, você precisará de uma assinatura. Se você não tiver uma conta existente do Azure, poderá se inscrever para uma avaliação gratuita ou usar os benefícios da assinatura do Visual Studio ao criar uma conta.
Um workspace Azure Synapse existente. Se você precisar criar um workspace Azure Synapse, poderá usar o Portal do Azure ou a CLI do Azure.

Se você usar a CLI do Azure, o comando terá a seguinte aparência:

az synapse workspace create \
    --name <your-workspace-name> \
    --resource-group <your-resource-group-name> \
    --storage-account <your-storage-account-name> \
    --file-system <your-storage-file-system-name> \
    --sql-admin-login-user <your-sql-admin-user-name> \
    --sql-admin-login-password <your-sql-admin-user-password> \
    --location <your-workspace-location>

Autenticar o cliente

Para interagir com o serviço Azure Synapse Analytics, você precisará criar uma instância da classe MonitoringClient. Você precisa de um ponto de extremidade de workspace, que você pode ver como "Ponto de extremidade de desenvolvimento" no portal e credenciais de segredo do cliente (ID do cliente, segredo do cliente, id de locatário) para instanciar um objeto cliente.

A autenticação de credencial de segredo do cliente está sendo usada nesta seção de introdução, mas você pode encontrar mais maneiras de autenticar com a identidade do Azure. Para usar o provedor DefaultAzureCredential mostrado abaixo ou outros provedores de credenciais fornecidos com o SDK do Azure, você deve instalar o pacote Azure.Identity:

Install-Package Azure.Identity

Principais conceitos

MonitoringClient

Com um, você pode obter uma MonitoringClient lista de aplicativos Spark ou consulta OD/DW do SQL para o workspace.

Acesso thread-safe

Garantimos que todos os métodos de instância do cliente sejam thread-safe e independentes uns dos outros (diretriz). Isso garante que a recomendação de reutilize instâncias de cliente seja sempre segura, mesmo entre threads.

Conceitos adicionais

Exemplos

O pacote Azure.Analytics.Synapse.Monitoring dá suporte a APIs síncronas e assíncronas. A seção a seguir aborda algumas das tarefas relacionadas ao monitoramento do Azure Synapse Analytics mais comuns:

Obter lista de aplicativos Spark

GetSparkJobList obtém uma lista de aplicativos spark para o workspace.

SparkJobListViewResponse sparkJobList = client.GetSparkJobList();
foreach (var sparkJob in sparkJobList.SparkJobs)
{
    if (sparkJob.State == "Running")
    {
        Console.WriteLine ($"{sparkJob.Name} has been running for {sparkJob.RunningDuration}");
    }
    else
    {
        Console.WriteLine ($"{sparkJob.Name} has been in {sparkJob.State} for {sparkJob.QueuedDuration}");
    }
}

Obter consulta SQL

GetSqlJobQueryString obtém a consulta OD/DW do SQL

SqlQueryStringDataModel sqlQuery = client.GetSqlJobQueryString();

Para compilar

Para obter informações sobre como criar a biblioteca de clientes Azure Synapse, consulte Criando o SDK do Microsoft Azure para .NET

Frameworks de destino

Para obter informações sobre as estruturas de destino da biblioteca de clientes Azure Synapse, consulte as Estruturas de Destino do SDK do Microsoft Azure para .NET.

Solução de problemas

Abra o problema no github.

Próximas etapas

A próxima etapa é adicionar mais exemplos

Participante

Este projeto adotou o Código de Conduta de Software Livre da Microsoft. Para obter mais informações, confira as Perguntas frequentes sobre o Código de Conduta ou contate opencode@microsoft.com para enviar outras perguntas ou comentários.

Compartilhar via