Biblioteca de clientes dos Gêmeos Digitais do Azure IoT para .NET – versão 1.4.0

Artigo
04/20/2023

Essa biblioteca fornece acesso ao serviço gêmeos digitais do Azure para gerenciar gêmeos, modelos, relações etc.

Introdução

O SDK completo do Microsoft Azure pode ser baixado na página de downloads do Microsoft Azure e é fornecido com suporte para a criação de pacotes de implantação, integração com ferramentas, ferramentas de linha de comando avançadas e muito mais.

Para obter a melhor experiência de desenvolvimento, os desenvolvedores devem usar os pacotes NuGet oficiais da Microsoft para bibliotecas. Os pacotes NuGet são atualizados regularmente com novas funcionalidades e hotfixes.

Instalar o pacote

Instale a biblioteca de clientes dos Gêmeos Digitais do Azure para .NET com o NuGet:

dotnet add package Azure.DigitalTwins.Core

Exiba os detalhes do pacote em nuget.org.

Pré-requisitos

Uma assinatura do Microsoft Azure
- Para chamar os serviços do Microsoft Azure, crie uma assinatura do Azure.
Uma instância dos Gêmeos Digitais do Azure
- Para usar o SDK dos Gêmeos Digitais do Azure, primeiro crie uma instância dos Gêmeos Digitais usando uma das opções:
  - Usando portal do Azure
  - Usando APIs de Gerenciamento do Azure
  - Usando a CLI do Azure
    - Você precisará instalar a CLI do Azure e a extensão de IoT do Azure para a CLI do Azure.
    - Consulte a documentação da CLI do IoT para obter mais informações sobre como criar e interagir com sua instância dos Gêmeos Digitais.

Autenticar o cliente

Para interagir com o serviço dos Gêmeos Digitais do Azure, você precisará criar uma instância de uma classe TokenCredential e passá-la para o construtor de seu DigitalTwinsClient.

Principais conceitos

A versão prévia dos Gêmeos Digitais do Azure são um serviço de IoT do Azure que cria modelos abrangentes do ambiente físico. Eles podem criar grafos de inteligência espacial para modelar relações e interações entre pessoas, espaços e dispositivos.

Você pode saber mais sobre os Gêmeos Digitais do Azure visitando a Documentação dos Gêmeos Digitais do Azure

Acesso thread-safe

Garantimos que todos os métodos de instância do cliente sejam thread-safe e independentes uns dos outros (diretriz). Isso garante que a recomendação de reutilize instâncias de cliente seja sempre segura, mesmo entre threads.

Conceitos adicionais

Exemplos

Você pode se familiarizar com APIs diferentes usando exemplos de Gêmeos Digitais.

Estrutura da pasta do código-fonte

/Src

O cliente público dos Gêmeos Digitais, DigitalTwinsCliente as opções de configuração adicionais, DigitalTwinsClientOptions, que podem ser enviadas para o serviço gêmeos digitais.

/src/Generated

O código gerado pelo autorest usando o arquivo swagger definido no arquivo de configuração mais automático.

Para regenerar o código, execute o script do PowerShell generate.ps1.

Sempre que o código da biblioteca de clientes é atualizado, os seguintes scripts precisam ser executados:

Export-AdtApis.ps1, que atualizará o documento surface da API.
Update-Snippets.ps1, que atualizará todos os snippets de código nos arquivos leiame e nos comentários da documentação do cliente.

/src/Customized

O código personalizado gravado para substituir o seguinte comportamento do código gerado automaticamente:

Renomeie alguns dos tipos gerados, por exemplo. GetModelsOptions
Declare alguns dos tipos gerados como internos, em vez do padrão de registro automático público.
Declare alguns métodos para aceitar parâmetros de entrada como cadeias de caracteres em vez de objetos .
Declare alguns métodos para retornar a resposta como cadeias de caracteres em vez de objetos .

/src/Models

Classes de modelo úteis para uso com as operações de cliente dos Gêmeos Digitais.

/src/Properties

Propriedades de assembly necessárias para executar testes de unidade.

/src/Serialization

Auxiliares de serialização fornecidos para ajudar a serializar/desserializar tipos comumente usados no serviço gêmeos digitais.

Solução de problemas

Todas as operações de serviço lançarão RequestFailedException em caso de falha relatada pelo serviço, com códigos de erro úteis e outras informações.

Por exemplo, use a GetModelAsync operação para marcar se o modelo existir antes de criá-lo, capture somente quando esse HttpStatusCode específico for especificado.

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

Próximas etapas

Confira exemplos de implementação com nossos exemplos de código.

Contribuição

Este projeto aceita contribuições e sugestões. A maioria das contribuições exige que você concorde com um CLA (Contrato de Licença do Colaborador) declarando que você tem o direito de nos conceder, e de fato concede, os direitos de usar sua contribuição. Para obter detalhes, acesse https://cla.microsoft.com.

Quando você envia uma solicitação de pull, um bot do CLA determina automaticamente se você precisa fornecer um CLA e preencher a PR corretamente (por exemplo, rótulo, comentário). Basta seguir as instruções fornecidas pelo bot. Você só precisará fazer isso uma vez em todos os repositórios que usam nosso CLA.

Este projeto adotou o Código de Conduta de Software Livre da Microsoft. Para obter mais informações, confira as Perguntas frequentes sobre o Código de Conduta ou contate opencode@microsoft.com para enviar outras perguntas ou comentários.