Azure Synapse Analytics-Überwachungsclientbibliothek für .NET– Version 1.0.0-beta.3

Artikel
04/21/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.

Azure Synapse Analytics bietet umfassende Überwachungsfunktionen im Azure-Portal, um Erkenntnisse zu Ihrer Data Warehouse-Workload zu gewinnen. Die Azure Synapse Analytics-Überwachungsclientbibliothek ermöglicht die programmgesteuerte Überwachung Ihrer Ressourcen.

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 bietet Unterstützung für die Erstellung von Bereitstellungspaketen, die Integration in Tools, umfangreiche Befehlszeilentools und vieles mehr.

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-Überwachungsclientbibliothek für .NET mit NuGet:

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

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 dem Azure Synapse Analytics-Dienst zu interagieren, müssen Sie eine instance der MonitoringClient-Klasse 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 Anbieter DefaultAzureCredential oder andere Anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, sollten Sie das Azure.Identity-Paket installieren:

Install-Package Azure.Identity

Wichtige Begriffe

MonitoringClient

Mit einem MonitoringClient können Sie eine Liste von Spark-Anwendungen oder SQL OD/DW-Abfragen für den Arbeitsbereich abrufen.

Threadsicherheit

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

Zusätzliche Konzepte

Beispiele

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

Abrufen der Liste der Spark-Anwendungen

GetSparkJobList ruft eine Liste der Spark-Anwendungen für den Arbeitsbereich ab.

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}");
    }
}

Abrufen einer SQl-Abfrage

GetSqlJobQueryString ruft die SQL OD/DW-Abfrage ab.

SqlQueryStringDataModel sqlQuery = client.GetSqlJobQueryString();

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.

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.