Azure IoT Time Series Insights-Clientbibliothek für .NET– Version 1.0.0-beta.1

Artikel
04/19/2023

Diese Bibliothek bietet Zugriff auf den Azure Time Series Insights-Dienst.

Erste Schritte

Das vollständige Microsoft Azure SDK kann von der Microsoft Azure-Downloadseite heruntergeladen werden und bietet Unterstützung für das Erstellen 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

Für diese Clientbibliothek wurde noch kein Paket veröffentlicht.

Voraussetzungen

Ein Microsoft Azure-Abonnement.
- Um Microsoft Azure-Dienste aufzurufen, erstellen Sie ein Azure-Abonnement.

Authentifizieren des Clients

Um mit dem Azure Time Series Insights-Dienst zu interagieren, müssen Sie eine instance einer TokenCredential-Klasse erstellen und an den Konstruktor Ihres TimeSeriesInsightsClient übergeben.

Wichtige Begriffe

Zu den Standard Konzepten des Time Series Insights-Clients gehören:

Instanzclient: Zum Ausführen von Vorgängen wie dem Erstellen, Auflisten, Ersetzen und Löschen von Time Series-Instanzen.
Typenclient: Zum Ausführen von Vorgängen wie dem Erstellen, Auflisten, Ersetzen und Löschen von Time Series-Typen.
Hierarchienclient: Zum Ausführen von Vorgängen wie dem Erstellen, Auflisten, Ersetzen und Löschen von Time Series-Hierarchien.
Modelleinstellungsclient: Zum Ausführen von Vorgängen wie dem Abrufen und Aktualisieren von Konfigurationseinstellungen für Das Zeitreihenmodell.
Abfrageclient: Zum Abfragen von Ereignissen, Reihen und Aggregatreihen in Time Series Insights.

Threadsicherheit

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

Zusätzliche Konzepte

Beispiele

Mithilfe von Beispielen für Time Series Insights können Sie sich mit verschiedenen APIs vertraut machen.

Struktur des Quellcodeordners

/Src

Der öffentliche Time Series Insights-Client und TimeSeriesInsightsClientdie zusätzlichen Konfigurationsoptionen , TimeSeriesInsightsClientOptionsdie an den Time Series Insights-Dienst gesendet werden können.

/src/Generiert

Der Code, der von autorest mithilfe der in der automatischsten Konfigurationsdatei definierten Swagger-Datei generiert wird.

Führen Sie das PowerShell-Skriptgenerate.ps1aus, um den Code erneut zu generieren.

Bei jeder Aktualisierung des Clientbibliothekscodes müssen die folgenden Skripts ausgeführt werden:

Export-AdtApis.ps1, wodurch das API-Oberflächendokument aktualisiert wird.
Update-Snippets.ps1, wodurch alle Codeausschnitte in den Infodateien und in den Clientdokumentationskommentaren aktualisiert werden.

/src/Customized

Der benutzerdefinierte Code, der geschrieben wurde, um das folgende Verhalten des automatisch generierten Codes außer Kraft zu setzen:

Deklarieren Sie einige der generierten Typen als intern anstelle des automatischsten Standardwerts public.

/src/Models

Modellklassen, die für die Verwendung mit den Time Series Insights-Clientvorgängen nützlich sind.

/src/Properties

Assemblyeigenschaften, die für die Ausführung von Komponententests erforderlich sind.

Problembehandlung

Time Series Insights-Dienstvorgangsfehler werden in der Regel als TimeSeriesOperationError an den Benutzer zurückgegeben. Die TimeSeriesOperationError-Antwort wird entweder direkt von der Clientbibliotheks-API oder als geschachtelte Eigenschaft innerhalb der tatsächlichen Antwort für die Clientbibliotheks-API zurückgegeben. Beispielsweise gibt die DeleteByName-API, die Teil des Hierarchies-Clients ist, direkt einen TimeSeriesOperationError-Wert zurück. Die Ersetzungs-API, die Teil des Instanzclients ist, gibt hingegen ein InstancesOperationResult zurück, in dem eine TimeSeriesOperationError-Eigenschaft geschachtelt ist.

Das folgende Beispiel zeigt die Verwendung des TimeSeriesInsightsSampleGetTypeById-Vorgangs, der durch einen Antwortfehler durchlaufen wird, um herauszufinden, ob ein Typ nicht vorhanden ist.

// Code snippet below shows getting a default Type using Id
// The default type Id can be obtained programmatically by using the ModelSettings client.

TimeSeriesInsightsModelSettings modelSettingsClient = client.GetModelSettingsClient();
TimeSeriesModelSettings modelSettings = await modelSettingsClient.GetAsync();
Response<TimeSeriesTypeOperationResult[]> getTypeByIdResults = await typesClient
    .GetByIdAsync(new string[] { modelSettings.DefaultTypeId });

// The response of calling the API contains a list of type or error objects corresponding by position to the input parameter array in the request.
// If the error object is set to null, this means the operation was a success.
for (int i = 0; i < getTypeByIdResults.Value.Length; i++)
{
    if (getTypeByIdResults.Value[i].Error == null)
    {
        Console.WriteLine($"Retrieved Time Series type with Id: '{getTypeByIdResults.Value[i].TimeSeriesType.Id}'.");
    }
    else
    {
        Console.WriteLine($"Failed to retrieve a Time Series type due to '{getTypeByIdResults.Value[i].Error.Message}'.");
    }
}

Nächste Schritte

Sehen Sie sich Implementierungsbeispiele mit unseren Codebeispielen an.

Mitwirken

Beiträge und Vorschläge für dieses Projekt sind willkommen. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. Einzelheiten dazu finden Sie unter https://cla.microsoft.com..

Wenn Sie einen Pull Request (PR) übermitteln, überprüft ein CLA-Bot automatisch, ob Sie eine Lizenzvereinbarung bereitstellen und den PR entsprechend ergänzen müssen (z.B. mit einer Bezeichnung oder einem Kommentar). Führen Sie einfach die Anweisungen des Bots aus. Sie müssen dies nur einmal für alle Repositorys ausführen, die unsere CLA verwenden.

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.

Freigeben über