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

Além de gerenciar sua 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 você pode usar para realizar a maioria das ações principais com o serviço. Este artigo aborda o conjunto de comandos da CLI do Azure para Azure Digital Twins, incluindo seus usos, como obtê-lo e os requisitos para usá-lo.

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

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

O conjunto de comandos é chamado az dte faz parte da extensão de IoT do Azure para a 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 geralmente sua instância, 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 garantir que você tenha a extensão mais recente azure-iot com os az dt comandos.

Requisitos de versão da CLI

Se você estiver usando a CLI do Azure com o PowerShell, sua versão da CLI do Azure deverá 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, consulte Como instalar a CLI do Azure.

Obter a extensão

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

Caso contrário, você poderá usar o comando a seguir para instalar a extensão por conta própria a qualquer momento (ou atualizá-la se você já tiver uma versão mais antiga). O comando pode ser executado no Azure Cloud Shell ou em uma CLI local do Azure.

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

Utilizar caracteres especiais em diferentes ambientes de shell

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 escapar de caracteres especiais no shell de sua escolha.

Bash (interpretador de comandos Unix)

Use estas dicas de caracteres especiais para ambientes bash.

Perguntas

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 Bash do Cloud Shell:

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

PowerShell

Use estas 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 o JSON em linha no ambiente do PowerShell, faça escape dos caracteres de aspas duplas (") dentro do JSON com uma barra 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}'

Perguntas

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'"

CMD do Windows

Use estas dicas de caracteres especiais para o CMD do 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 o JSON em linha em uma janela do CMD local do Windows, coloque o valor do parâmetro entre aspas duplas (") em vez de aspas simples (') e faça escape dos caracteres de aspas duplas dentro do JSON com uma barra invertida (\).

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

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

Próximas etapas

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

• Referência de comando az dt