Azure Synapse Analytics Artifacts-Clientbibliothek für .NET – Version 1.0.0-preview.18

Artikel
07/31/2023

Dieses Verzeichnis enthält die Open Source Teilmenge des .NET SDK. Die Dokumentation zum vollständigen Azure SDK finden Sie im Microsoft Azure .NET Developer Center.

Die Azure Synapse Analytics-Entwicklungsclientbibliothek ermöglicht die programmgesteuerte Verwaltung von Artefakten und bietet Methoden zum Erstellen, Aktualisieren, Auflisten und Löschen von Pipelines, Datasets, Datenflüssen, Notebooks, Spark-Auftragsdefinitionen, SQL-Skripts, verknüpften Diensten und Triggern.

Azure Synapse ist ein unbegrenzter Analysedienst, der Data Warehousing für Unternehmen mit Big Data-Analysen vereint. Er ermöglicht flexible Datenabfragen nach Ihren Vorstellungen, indem serverlose On-Demand-Ressourcen oder bereitgestellten Ressourcen im gewünschten Umfang verwendet werden. Azure Synapse kombiniert diese beiden Welten in einer vereinheitlichten Oberfläche zur Erfassung, Vorbereitung, Verwaltung und Verarbeitung von Daten für sofortige BI- und Machine Learning-Anforderungen.

Erste Schritte

Das vollständige Microsoft Azure SDK kann von der Microsoft Azure-Downloadseite heruntergeladen werden und wird mit Unterstützung für die Erstellung von Bereitstellungspaketen, die Integration in Tools, umfangreiche Befehlszeilentools und vieles mehr bereitgestellt.

Für eine optimale Entwicklungserfahrung sollten Entwickler die offiziellen Microsoft NuGet-Pakete für Bibliotheken verwenden. NuGet-Pakete werden regelmäßig mit neuen Funktionen und Hotfixes aktualisiert.

Installieren des Pakets

Installieren Sie die Azure Synapse Analytics-Entwicklungsclientbibliothek für .NET mit NuGet:

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

Voraussetzungen

Azure-Abonnement: Für die Verwendung von Azure-Diensten, einschließlich Azure Synapse, benötigen Sie ein Abonnement. Wenn Sie nicht über ein vorhandenes Azure-Konto verfügen, können Sie sich für eine kostenlose Testversion registrieren oder Ihre Visual Studio-Abonnementvorteile nutzen, wenn Sie ein Konto erstellen.
Ein vorhandener Azure Synapse Arbeitsbereich. Wenn Sie einen Azure Synapse Arbeitsbereich erstellen müssen, können Sie das Azure-Portal oder die Azure CLI verwenden.

Wenn Sie die Azure CLI verwenden, sieht der Befehl wie folgt aus:

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>

Authentifizieren des Clients

Um mit einem Teil des Azure Synapse Analytics-Diensts zu interagieren, müssen Sie eine instance der jeweiligen Clientklasse erstellen:

Sie benötigen einen Arbeitsbereichsendpunkt, der im Portal möglicherweise als "Entwicklungsendpunkt" angezeigt wird, und anmeldeinformationen für geheime Clientschlüssel (Client-ID, geheimer Clientschlüssel, Mandanten-ID), um ein Clientobjekt zu instanziieren.

Die Authentifizierung von Anmeldeinformationen für geheime Clientschlüssel wird in diesem Abschnitt zu den ersten Schritten verwendet, aber Sie finden weitere Möglichkeiten zur Authentifizierung mit Azure-Identität. Um den unten gezeigten DefaultAzureCredential-Anbieter oder andere Anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, sollten Sie das Azure.Identity-Paket installieren:

dotnet add package Azure.Identity

Beispiele

Das Paket Azure.Analytics.Synapse.Artifacts unterstützt synchrone und asynchrone APIs. Im folgenden Abschnitt werden einige der häufigsten Azure Synapse Analytics-Entwicklungsaufgaben behandelt:

Erstellen eines Notebooks

CreateOrUpdateNotebook erstellt ein Notebook.

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

Abrufen eines Notebooks

GetNoteBook ruft ein Notebook ab.

NotebookResource retrievedNotebook = client.GetNotebook(notebookName);

Auflisten von Notebooks

GetNotebooksByWorkspace Listet die Notebooks im Synapse-Arbeitsbereich auf.

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

Löschen eines Notebooks

DeleteNotebook löscht ein Notebook.

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

So erstellen Sie

Informationen zum Erstellen der Azure Synapse-Clientbibliothek finden Sie unter Erstellen der Microsoft Azure SDK für .NET

Zielframeworks

Informationen zu den Zielframeworks der Azure Synapse-Clientbibliothek finden Sie in den Zielframeworks der Microsoft Azure SDK für .NET.

Wichtige Begriffe

NotebookControlClient

Mit einem Notebookclient können Sie Pipelines, Datasets, Datenflüsse, Notebooks, Spark-Auftragsdefinitionen, SQL-Skripts, verknüpfte Dienste und Trigger erstellen, aktualisieren, auflisten und löschen.

Threadsicherheit

Wir garantieren, dass alle Client-instance Methoden threadsicher und unabhängig voneinander sind (Richtlinie). Dadurch wird sichergestellt, dass die Empfehlung, Clientinstanzen wiederzuverwenden, immer sicher ist, auch über Threads hinweg.

Zusätzliche Konzepte

Problembehandlung

Öffnen Sie das Problem in GitHub.

Nächste Schritte

Der nächste Schritt besteht darin, weitere Beispiele hinzuzufügen.

Mitwirken

Für dieses Projekt gelten die Microsoft-Verhaltensregeln für Open Source (Microsoft Open Source Code of Conduct). Weitere Informationen finden Sie in den häufig gestellten Fragen zum Verhaltenskodex. Sie können sich auch an opencode@microsoft.com wenden, wenn Sie weitere Fragen oder Anmerkungen haben.