Bibliothèque cliente Azure IoT Digital Twins pour .NET - version 1.4.0

Article
04/19/2023

Cette bibliothèque permet d’accéder au service Azure Digital Twins pour la gestion des jumeaux, des modèles, des relations, etc.

| Code source Package (nuget)

Prise en main

L’intégralité du Kit de développement logiciel (SDK) Microsoft Azure peut être téléchargée à partir de la page téléchargements Microsoft Azure , et il est fourni avec la prise en charge de la création de packages de déploiement, l’intégration avec des outils, des outils en ligne de commande enrichis, etc.

Pour une expérience de développement optimale, les développeurs doivent utiliser les packages Microsoft NuGet officiels pour les bibliothèques. Les packages NuGet sont régulièrement mis à jour avec de nouvelles fonctionnalités et correctifs logiciels.

Installer le package

Installez la bibliothèque cliente Azure Digital Twins pour .NET avec NuGet :

dotnet add package Azure.DigitalTwins.Core

Affichez les détails du package sur nuget.org.

Prérequis

Un abonnement Microsoft Azure.
- Pour appeler les services Microsoft Azure, créez un abonnement Azure.
Un instance Azure Digital Twins
- Pour utiliser le Kit de développement logiciel (SDK) Azure Digital Twins, commencez par créer un instance Digital Twins à l’aide de l’une des options suivantes :
  - Utilisation de Portail Azure
  - Utilisation des API de gestion Azure
  - Utilisation d’Azure CLI
    - Vous devez installer azure cli et l’extension Azure IoT pour Azure CLI.
    - Pour plus d’informations sur la création et l’interaction avec votre instance Digital Twins, consultez la documentation cli IoT.

Authentifier le client

Pour interagir avec le service Azure Digital Twins, vous devez créer une instance d’une classe TokenCredential et la transmettre au constructeur de votre DigitalTwinsClient.

Concepts clés

La préversion d’Azure Digital Twins est un service Azure IoT qui permet de créer des modèles complets de l’environnement physique. Il peut créer des graphes d’intelligence spatiale afin de modéliser les relations et les interactions entre les personnes, les espaces et les appareils.

Pour en savoir plus sur Azure Digital Twins, consultez la documentation Azure Digital Twins.

Sécurité des threads

Nous garantissons que toutes les méthodes de instance client sont sécurisées pour les threads et indépendantes les unes des autres (recommandations). Cela garantit que la recommandation de réutilisation des instances clientes est toujours sécurisée, même entre les threads.

Concepts supplémentaires

Exemples

Vous pouvez vous familiariser avec différentes API à l’aide d’exemples pour Digital Twins.

Structure des dossiers de code source

/src

Le client public Digital Twins, DigitalTwinsClientet les options de configuration supplémentaires, DigitalTwinsClientOptions, qui peuvent être envoyées au service Digital Twins.

/src/Generated

Code généré par autorest à l’aide du fichier swagger défini dans le fichier de configuration autorest.

Pour régénérer le code, exécutez le script powershell generate.ps1.

Chaque fois que le code de la bibliothèque cliente est mis à jour, les scripts suivants doivent être exécutés :

Export-AdtApis.ps1, qui met à jour le document surface d’API.
Update-Snippets.ps1, qui met à jour tous les extraits de code dans les fichiers readme et dans les commentaires de la documentation cliente.

/src/Personnalisation

Code personnalisé écrit pour remplacer le comportement suivant du code généré automatiquement :

Renommez certains des types générés, par exemple. GetModelsOptions
Déclarez certains des types générés en tant qu’internes, au lieu de la valeur par défaut de la récupération automatique de public.
Déclarez certaines méthodes pour accepter les paramètres d’entrée sous forme de chaînes au lieu d’objets.
Déclarez certaines méthodes pour renvoyer la réponse sous forme de chaînes au lieu d’objets.

/src/Models

Classes de modèle utiles pour une utilisation avec les opérations clientes Digital Twins.

/src/Properties

Propriétés d’assembly requises pour exécuter des tests unitaires.

/src/Sérialisation

Assistances de sérialisation fournies pour aider à sérialiser/désérialiser les types couramment utilisés au sein du service Digital Twins.

Dépannage

Toutes les opérations de service lèvent RequestFailedException en cas d’échec signalé par le service, avec des codes d’erreur utiles et d’autres informations.

Par exemple, utilisez l’opération GetModelAsync pour case activée si le modèle existe avant de le créer, interceptez uniquement lorsque ce HttpStatusCode spécifique est spécifié.

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

Étapes suivantes

Consultez des exemples d’implémentation avec nos exemples de code.

Contribution

Ce projet accepte les contributions et les suggestions. La plupart des contributions vous demandent d’accepter un contrat de licence de contribution (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez réellement, les droits d’utilisation de votre contribution. Pour plus d’informations, consultez https://cla.microsoft.com.

Quand vous envoyez une demande de tirage (pull request), un bot CLA détermine automatiquement si vous devez fournir un contrat CLA et agrémenter la demande de tirage de façon appropriée (par exemple, avec une étiquette ou un commentaire). Suivez simplement les instructions fournies par le bot. Vous ne devez effectuer cette opération qu’une seule fois sur tous les dépôts utilisant notre contrat CLA.

Ce projet a adopté le Code de conduite Open Source de Microsoft. Pour plus d’informations, consultez les Questions fréquentes (FAQ) sur le code de conduite ou envoyez vos questions ou vos commentaires à opencode@microsoft.com.

Partager via