Biblioteca cliente de Azure IoT Digital Twins para .NET, versión 1.4.0

Esta biblioteca proporciona acceso al servicio Azure Digital Twins para administrar gemelos, modelos, relaciones, etc.

Código | fuente Paquete (nuget)

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 para compilar paquetes de implementación, integrar 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

Instale la biblioteca cliente de Azure Digital Twins para .NET con NuGet:

dotnet add package Azure.DigitalTwins.Core

Vea los detalles del paquete en nuget.org.

Requisitos previos

• Una suscripción de Microsoft Azure.
  • Para llamar a los servicios de Microsoft Azure, cree una suscripción de Azure.
• Una instancia de Azure Digital Twins
  • Para usar el SDK de Azure Digital Twins, cree primero una instancia de Digital Twins mediante una de las opciones:
    • Uso de Azure Portal
    • Uso de las API de administración de Azure
    • Uso de la CLI de Azure
      • Deberá instalar la cli de Azure y la extensión de Azure IoT para la CLI de Azure.
      • Consulte la documentación de la CLI de IoT para obtener más información sobre cómo crear e interactuar con la instancia de Digital Twins.

Autenticación del cliente

Para interactuar con el servicio Azure Digital Twins, deberá crear una instancia de una clase TokenCredential y pasarla al constructor de DigitalTwinsClient.

Conceptos clave

La versión preliminar de Azure Digital Twins es un servicio de Azure IoT que crea modelos completos del entorno físico. Puede crear grafos de inteligencia espacial para modelar las relaciones y las interacciones entre personas, espacios y dispositivos.

Para más información sobre Azure Digital Twins, visite la documentación de Azure Digital Twins.

Seguridad para subprocesos

Garantizamos que todos los métodos de instancia de cliente son seguros para subprocesos e independientes entre sí (instrucciones). Esto garantiza que la recomendación de reutilizar instancias de cliente siempre es segura, incluso entre subprocesos.

Conceptos adicionales

Opciones | de cliente Acceso a la respuesta | Operaciones | de larga duraciónControl de errores | Diagnóstico | Burla | Duración del cliente

Ejemplos

Puede familiarizarse con diferentes API mediante ejemplos de Digital Twins.

Estructura de carpetas de código fuente

/Fuente

El cliente público de Digital Twins, DigitalTwinsClienty las opciones de configuración adicionales, DigitalTwinsClientOptions, que se pueden enviar al servicio Digital Twins.

/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 actualice 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 documentación del cliente.

/src/Customized

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

• Cambie el nombre de algunos de los tipos generados, por ejemplo, GetModelsOptions
• Declare algunos de los tipos generados como internos, en lugar del valor predeterminado autorest de public.
• Declare algunos métodos para aceptar parámetros de entrada como cadenas en lugar de objetos.
• Declare algunos métodos para devolver la respuesta como cadenas en lugar de objetos .

/src/Models

Las clases de modelo son útiles para su uso con las operaciones de cliente de Digital Twins.

/src/Properties

Propiedades de ensamblado necesarias para ejecutar pruebas unitarias.

/src/Serialization

Asistentes de serialización proporcionados para ayudar a serializar o deserializar tipos usados habitualmente en el servicio Digital Twins.

Solución de problemas

Todas las operaciones de servicio producirán RequestFailedException en caso de error notificado por el servicio, con códigos de error útiles y otra información.

Por ejemplo, use la GetModelAsync operación para comprobar si el modelo existe antes de crearlo, detectar solo cuando se especifica ese HttpStatusCode específico.

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

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.