Azure IoT Digital Twins-Clientbibliothek für .NET– Version 1.4.0

Artikel
04/19/2023

Diese Bibliothek bietet Zugriff auf den Azure Digital Twins-Dienst zum Verwalten von Zwillingen, Modellen, Beziehungen usw.

Quellcode | Paket (NuGet)

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

Installieren Sie die Azure Digital Twins-Clientbibliothek für .NET mit NuGet:

dotnet add package Azure.DigitalTwins.Core

Sehen Sie sich die Paketdetails unter nuget.org an.

Voraussetzungen

Ein Microsoft Azure-Abonnement.
- Um Microsoft Azure-Dienste aufzurufen, erstellen Sie ein Azure-Abonnement.
Eine Azure Digital Twins-instance
- Um das Azure Digital Twins SDK zu verwenden, erstellen Sie zunächst eine Digital Twins-instance mit einer der folgenden Optionen:
  - Verwenden von Azure-Portal
  - Verwenden von Azure-Verwaltungs-APIs
  - Verwenden der Azure CLI
    - Sie müssen die Azure Cli und die Azure IoT-Erweiterung für die Azure CLI installieren.
    - Weitere Informationen zum Erstellen und Interagieren Ihrer Digital Twins-instance finden Sie in der IoT CLI-Dokumentation.

Authentifizieren des Clients

Um mit dem Azure Digital Twins-Dienst zu interagieren, müssen Sie eine instance einer TokenCredential-Klasse erstellen und an den Konstruktor Ihres DigitalTwinsClient übergeben.

Wichtige Begriffe

Azure Digital Twins (Vorschauversion) ist ein Azure IoT-Dienst zur Erstellung umfassender Modelle der physischen Umgebung. Er kann Raumintelligenzgraphen erstellen, um die Beziehungen und Interaktionen zwischen Personen, Bereichen und Geräten zu modellieren.

Weitere Informationen zu Azure Digital Twins finden Sie in der Dokumentation zu Azure Digital Twins.

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

Mithilfe von Beispielen für Digital Twins können Sie sich mit verschiedenen APIs vertraut machen.

Struktur des Quellcodeordners

/Src

Der öffentliche Digital Twins-Client und DigitalTwinsClientdie zusätzlichen Konfigurationsoptionen , DigitalTwinsClientOptionsdie an den Digital Twins-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:

Benennen Sie einige der generierten Typen um, z. B. GetModelsOptions
Deklarieren Sie einige der generierten Typen als intern anstelle des automatischsten Standardwerts public.
Deklarieren Sie einige Methoden, um Eingabeparameter als Zeichenfolgen anstelle von Objekten zu akzeptieren.
Deklarieren Sie einige Methoden, um die Antwort als Zeichenfolgen anstelle von -Objekten zurückzugeben.

/src/Models

Modellklassen, die für die Verwendung mit den Digital Twins-Clientvorgängen nützlich sind.

/src/Properties

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

/src/Serialisierung

Serialisierungshilfsprogramme, die zur Serialisierung/Deserialisierung häufig verwendeter Typen im Digital Twins-Dienst bereitgestellt werden.

Problembehandlung

Alle Dienstvorgänge lösen RequestFailedException bei fehlern aus, die vom Dienst gemeldet wurden, mit hilfreichen Fehlercodes und anderen Informationen.

Verwenden Sie z. B. den GetModelAsync Vorgang, um zu überprüfen, ob das Modell vorhanden ist, bevor Sie es erstellen. Catch nur, wenn dieser spezifische HttpStatusCode angegeben ist.

try
{
    Response<ModelData> desiredModel = await DigitalTwinsClient.GetModelAsync(desiredModelId);
}
catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotFound)
{
    // Model does not exist, so create it.
}

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