Conjunto de comandos da CLI dos Gêmeos Digitais do Azure

  • Artigo

Além de gerenciar a instância dos Gêmeos Digitais do Azure no portal do Azure, os Gêmeos Digitais do Azure também têm um conjunto de comandos para a CLI do Azure que pode ser usada para executar a maioria das ações principais com o serviço. Este artigo abrange o conjunto de comandos da CLI do Azure para os gêmeos digitais do Azure, incluindo seus usos, como obtê-los e os requisitos para usá-los.

Algumas das ações que você pode fazer usando o conjunto de comandos incluem:

  • Gerenciar uma instância dos Gêmeos Digitais do Azure
  • Gerenciar modelos
  • Gerenciar gêmeos digitais
  • Gerenciar relações de gêmeo
  • Configurando pontos de extremidade
  • Gerenciar rotas
  • Configurar a segurança por meio do RBAC (controle de acesso baseado em função) do Azure

O conjunto de comandos é chamado az dt e faz parte da Extensão de IoT para CLI do Azure. Você pode exibir a lista completa de comandos e o respectivo uso como parte da documentação de referência para o az iotconjunto de comandos: referência de comando az dt.

Usos (implantar e validar)

Além de gerenciar a instância de modo geral, a CLI também é uma ferramenta útil para implantação e validação.

  • Os comandos do painel de controle podem ser usados para tornar a implantação de uma nova instância repetível ou automatizada.
  • Os comandos do plano de dados podem ser usados para verificar rapidamente os valores na instância e checar se as operações foram concluídas conforme o previsto.

Obter o conjunto de comandos

Os comandos dos Gêmeos Digitais do Azure fazem parte da extensão de IoT do Azure para a CLI do Azure (azure-iot). Portanto, siga estas etapas para verificar se você tem a extensão azure-iot mais recente com os comandos az dt.

Requisitos da versão da CLI

Se você estiver usando o CLI do Azure com o PowerShell, sua versão CLI do Azure deve ser 2.3.1 ou superior como um requisito do pacote de extensão.

Você pode verificar a versão da CLI do Azure com este comando da CLI:

az --version

Para obter instruções sobre como instalar ou atualizar a CLI do Azure para uma versão mais recente, confira Instalar a CLI do Azure.

Obter a extensão

A CLI do Azure solicitará automaticamente que você instale a extensão no primeiro uso de um comando que a exija.

Caso contrário, é possível usar o comando a seguir para instalar a extensão a qualquer momento (ou atualizá-la se já tiver uma versão mais antiga). O comando pode ser executado no Azure Cloud Shell ou em uma CLI do Azure local.

az extension add --upgrade --name azure-iot

Usar caracteres especiais em shells diferentes

Alguns comandos az dt usam caracteres especiais que podem ter que ser escapados para análise adequada em determinados ambientes de shell. Use as dicas nesta seção para ajudá-lo a saber quando fazer isso no shell de sua escolha.

Bash

Use essas dicas de caracteres especiais para ambientes Bash.

Consultas

Em muitas consultas de gêmeos, o caractere $ é usado para referenciar a propriedade $dtId de um gêmeo. Ao usar o comando az dt twin query para consultar no ambiente do Cloud Shell Bash, escape do caractere $ com uma faixa invertida ( \ ).

Aqui está um exemplo de consulta para um gêmeo com um comando da CLI no ambiente do Cloud Shell Bash:

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

PowerShell

Use essas dicas de caracteres especiais para ambientes do PowerShell.

JSON em linha

Alguns comandos, como az dt twin create, permitem que você insira informações de gêmeo na forma de JSON em linha. Ao inserir JSON em linha no ambiente do PowerShell, escape de caracteres de aspas duplas ( " ) dentro do JSON com uma faixa invertida ( \ ).

Aqui está um exemplo de criação de um gêmeo com um comando da CLI no PowerShell:

az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties '{\"Temperature\": 0.0}'

Dica

Muitos dos comandos que oferecem suporte ao JSON em linha também dão suporte à entrada como um caminho de arquivo, o que pode ajudá-lo a evitar requisitos de texto específicos do Shell.

Consultas

Em muitas consultas de gêmeos, o caractere $ é usado para referenciar a propriedade $dtId de um gêmeo. Ao usar o comando az dt twin query para consultar no ambiente do PowerShell, escape o caractere $ com um caractere de acento grave.

Aqui está um exemplo de consulta de um gêmeo com um comando da CLI no PowerShell:

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

Windows CMD

Use essas dicas de caractere especial para o CMD Windows local.

JSON em linha

Alguns comandos, como az dt twin create, permitem que você insira informações de gêmeo na forma de JSON em linha. Ao inserir JSON em linha em uma janela CMD local do Windows, coloque o valor do parâmetro entre aspas duplas ( " ) em vez de aspas simples ( ' ) e escape de caracteres de aspas duplas dentro do JSON com uma faixa invertida ( \ ).

Aqui está um exemplo de criação de um gêmeo com um comando da CLI no CMD local do Windows:

az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties "{\"Temperature\": 0.0}"

Dica

Muitos dos comandos que oferecem suporte ao JSON em linha também dão suporte à entrada como um caminho de arquivo, o que pode ajudá-lo a evitar requisitos de texto específicos do Shell.

Próximas etapas

Explore a CLI e o conjunto completo de comandos por meio dos documentos de referência: