Bibliothèque de client Azure IoT Time Series Insights pour .NET - version 1.0.0-beta.1

Article
05/08/2023

Cette bibliothèque permet d’accéder au service Azure Time Series Insights.

Prise en main

Le KIT de développement logiciel (SDK) Microsoft Azure complet peut être téléchargé à partir de la page de téléchargements Microsoft Azure , et il est fourni avec la prise en charge de la création de packages de déploiement, de 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

Aucun package n’a encore été publié pour cette bibliothèque cliente.

Prérequis

Un abonnement Microsoft Azure.
- Pour appeler les services Microsoft Azure, créez un abonnement Azure.

Authentifier le client

Pour interagir avec le service Azure Time Series Insights, vous devez créer une instance d’une classe TokenCredential et la transmettre au constructeur de votre TimeSeriesInsightsClient.

Concepts clés

Les concepts main du client Time Series Insights sont les suivants :

Client d’instances : pour effectuer des opérations telles que la création, la liste, le remplacement et la suppression d’instances time series.
Client types : pour effectuer des opérations telles que la création, la liste, le remplacement et la suppression de types de séries chronologiques.
Client de hiérarchies : pour effectuer des opérations telles que la création, la liste, le remplacement et la suppression de hiérarchies de séries chronologiques.
Client Paramètres du modèle : pour effectuer des opérations telles que l’obtention et la mise à jour des paramètres de configuration du modèle de série chronologique.
Client de requête : pour rechercher des événements, des séries et des séries agrégées sur Time Series Insights.

Sécurité des threads

Nous garantissons que toutes les méthodes de instance client sont thread-safe et indépendantes les unes des autres (instructions). Cela garantit que la 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 Time Series Insights.

Structure du dossier du code source

/src

Le client public Time Series Insights, TimeSeriesInsightsClientet les options de configuration supplémentaires, TimeSeriesInsightsClientOptions, qui peuvent être envoyées au service Time Series Insights.

/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 de l’API.
Update-Snippets.ps1, qui met à jour tous les extraits de code dans les fichiers lisez-moi et dans les commentaires de documentation du client.

/src/Custom

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

Déclarez certains des types générés comme internes, au lieu de la valeur par défaut d’autorest public.

/src/Models

Classes de modèle utiles pour une utilisation avec les opérations du client Time Series Insights.

/src/Properties

Propriétés d’assembly requises pour l’exécution de tests unitaires.

Dépannage

Les échecs d’opération du service Time Series Insights sont généralement retournés à l’utilisateur en tant que TimeSeriesOperationError. La réponse TimeSeriesOperationError est retournée directement par l’API de bibliothèque cliente ou en tant que propriété imbriquée dans la réponse réelle de l’API de bibliothèque cliente. Par exemple, l’API DeleteByName qui fait partie du client de hiérarchies retourne directement un Objet TimeSeriesOperationError. En revanche, l’API Replace qui fait partie du client d’instances renvoie une instance InstancesOperationResult, qui a une propriété TimeSeriesOperationError imbriquée.

L’exemple ci-dessous illustre l’utilisation de l’opération TimeSeriesInsightsSampleGetTypeById, itérer au sein de l’erreur de réponse pour déterminer si un type n’existe pas.

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

É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