biblioteca de clientes do Azure Synapse Analytics Artifacts para .NET – versão 1.0.0-preview.18

Artigo
07/31/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.

A biblioteca de clientes de desenvolvimento do Azure Synapse Analytics permite gerenciar artefatos programaticamente, oferecendo métodos para criar, atualizar, listar e excluir pipelines, conjuntos de dados, fluxos de dados, notebooks, definições de trabalho do Spark, scripts SQL, serviços vinculados e gatilhos.

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 Microsoft NuGet oficiais para bibliotecas. Os pacotes NuGet são atualizados regularmente com novas funcionalidades e hotfixes.

Instalar o pacote

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

dotnet add package Azure.Analytics.Synapse.Artifacts --prerelease

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 seus benefícios de assinatura do Visual Studio ao criar uma conta.
Um workspace Azure Synapse existente. Se precisar criar um workspace Azure Synapse, você poderá usar o Portal do Azure ou a CLI do Azure.

Se você usar a CLI do Azure, o comando será semelhante ao seguinte:

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 parte do serviço Azure Synapse Analytics, você precisará criar uma instância da respectiva classe de cliente:

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 do 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:

dotnet add package Azure.Identity

Exemplos

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

Criar um notebook

CreateOrUpdateNotebook cria um notebook.

NotebookCreateOrUpdateNotebookOperation operation = await client.StartCreateOrUpdateNotebookAsync(notebookName, notebookResource);
await operation.WaitForCompletionAsync();
Console.WriteLine("The notebook is created");

Recuperar um notebook

GetNoteBook recupera um notebook.

NotebookResource retrievedNotebook = client.GetNotebook(notebookName);

Listar blocos de anotações

GetNotebooksByWorkspace enumera os notebooks no workspace do Synapse.

Pageable<NotebookResource> notebooks = client.GetNotebooksByWorkspace();
foreach (NotebookResource notebook in notebooks)
{
    Console.WriteLine(notebook.Name);
}

Excluir um notebook

DeleteNotebook exclui um notebook.

NotebookDeleteNotebookOperation deleteNotebookOperation = client.StartDeleteNotebook(notebookName);
await deleteNotebookOperation.WaitForCompletionResponseAsync();

Para compilar

Para obter informações sobre como criar a biblioteca de clientes do 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.

Principais conceitos

NotebookControlClient

Com um cliente de notebook, você pode criar, atualizar, listar e excluir pipelines, conjuntos de dados, fluxos de dados, notebooks, definições de trabalho do Spark, scripts SQL, serviços vinculados e gatilhos.

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

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.