Biblioteca cliente de Azure IoT Time Series Insights para .NET: versión 1.0.0-beta.1

Artículo
04/18/2023

Esta biblioteca proporciona acceso al servicio Azure Time Series Insights.

Introducción

El SDK de Microsoft Azure completo se puede descargar desde la página de descargas de Microsoft Azure y se incluye con compatibilidad con la creación de paquetes de implementación, integración con herramientas, herramientas de línea de comandos enriquecidas, etc.

Para obtener la mejor experiencia de desarrollo, los desarrolladores deben usar los paquetes NuGet oficiales de Microsoft para bibliotecas. Los paquetes NuGet se actualizan periódicamente con nuevas funcionalidades y revisiones.

Instalar el paquete

Todavía no se ha publicado ningún paquete para esta biblioteca cliente.

Prerrequisitos

Una suscripción de Microsoft Azure.
- Para llamar a los servicios de Microsoft Azure, cree una suscripción de Azure.

Autenticación del cliente

Para interactuar con el servicio Azure Time Series Insights, deberá crear una instancia de una clase TokenCredential y pasarla al constructor de TimeSeriesInsightsClient.

Conceptos clave

Entre los conceptos principales del cliente de Time Series Insights se incluyen los siguientes:

Cliente de instancias: para realizar operaciones como crear, enumerar, reemplazar y eliminar instancias de Time Series.
Cliente de tipos: para realizar operaciones como crear, enumerar, reemplazar y eliminar tipos de serie temporal.
Cliente de jerarquías: para realizar operaciones como crear, enumerar, reemplazar y eliminar jerarquías de serie temporal.
Cliente de configuración del modelo: para realizar operaciones como obtener y actualizar las opciones de configuración del modelo de serie temporal.
Cliente de consulta: para consultar eventos, series y series agregadas en Time Series Insights.

Seguridad para subprocesos

Garantizamos que todos los métodos de instancia de cliente sean seguros para subprocesos e independientes entre sí (guía). Esto garantiza que la reutilización de instancias de cliente siempre sea segura, incluso entre subprocesos.

Conceptos adicionales

Ejemplos

Puede familiarizarse con diferentes API mediante ejemplos de Time Series Insights.

Estructura de carpetas de código fuente

/Fuente

El cliente público de Time Series Insights, TimeSeriesInsightsClient, y las opciones de configuración adicionales, TimeSeriesInsightsClientOptions, que se pueden enviar al servicio Time Series Insights.

/src/Generated

El código generado por autorest mediante el archivo swagger definido en el archivo de configuración autorest.

Para volver a generar el código, ejecute el script de PowerShell generate.ps1.

Cada vez que se actualiza el código de la biblioteca cliente, es necesario ejecutar los siguientes scripts:

Export-AdtApis.ps1, que actualizará el documento de superficie de API.
Update-Snippets.ps1, que actualizará todos los fragmentos de código de los archivos léame y en los comentarios de la documentación del cliente.

/src/Customized

El código personalizado escrito para invalidar el siguiente comportamiento del código generado automáticamente:

Declare algunos de los tipos generados como internos, en lugar del valor predeterminado autorest de public.

/src/Models

Clases de modelo útiles para su uso con las operaciones de cliente de Time Series Insights.

/src/Properties

Propiedades de ensamblado necesarias para ejecutar pruebas unitarias.

Solución de problemas

Los errores de operación del servicio Time Series Insights suelen devolverse al usuario como TimeSeriesOperationError. La respuesta TimeSeriesOperationError se devuelve directamente mediante la API de biblioteca cliente o como una propiedad anidada dentro de la respuesta real para la API de biblioteca cliente. Por ejemplo, la API DeleteByName que forma parte del cliente de jerarquías devuelve un timeSeriesOperationError directamente. Mientras que la API Replace que forma parte del cliente de instancias devuelve instancesOperationResult, que tiene una propiedad TimeSeriesOperationError anidada dentro de ella.

En el ejemplo siguiente se muestra el uso de la operación TimeSeriesInsightsSampleGetTypeById, recorrer en iteración el error de respuesta para averiguar si un tipo no existe.

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

Pasos siguientes

Consulte ejemplos de implementación con nuestros ejemplos de código.

Contribuciones

Este proyecto agradece las contribuciones y sugerencias. La mayoría de las contribuciones requieren que acepte un Contrato de licencia para el colaborador (CLA) que declara que tiene el derecho a concedernos y nos concede los derechos para usar su contribución. Para más información, visite https://cla.microsoft.com..

Cuando se envía una solicitud de incorporación de cambios, un bot de CLA determinará de forma automática si tiene que aportar un CLA y completar la PR adecuadamente (por ejemplo, la etiqueta, el comentario). Solo siga las instrucciones que le dará el bot. Solo será necesario que lo haga una vez en todos los repositorios con nuestro CLA.

Este proyecto ha adoptado el Código de conducta de Microsoft Open Source. Para más información, consulte las preguntas más frecuentes del código de conducta o póngase en contacto con opencode@microsoft.com si tiene cualquier otra pregunta o comentario.

Compartir a través de