Partilhar via

Conjunto de comandos da CLI do Azure Digital Twins

Além de gerenciar sua instância de Gêmeos Digitais do Azure no portal do Azure, o Azure Digital Twins também tem um conjunto de comandos para a CLI do Azure que você pode usar para executar 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 os seus usos, como consegui-lo e os requisitos para o utilizar.

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

  • Gerenciando uma instância do Azure Digital Twins
  • Modelos de gestão
  • Gerenciando gêmeos digitais
  • Gerenciando relacionamentos gêmeos
  • Configurando pontos de extremidade
  • Gestão de rotas
  • Configurando a segurança por meio do controle de acesso baseado em função do Azure (Azure RBAC)

O conjunto de comandos é chamado az dt, e faz parte da extensão do Azure IoT para Azure CLI. Você pode visualizar a lista completa de comandos e seu uso como parte da documentação de referência para o az iot conjunto de comandos: az dt command reference.

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 plano 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 em sua instância e verificar se as operações foram concluídas conforme o esperado.

Obter o conjunto de comandos

Os comandos do Azure Digital Twins fazem parte da extensão do Azure IoT 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 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 na primeira utilização de um comando que a exija.

Caso contrário, você pode usar o seguinte comando para instalar a extensão 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 do Azure local.

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

Usar caracteres especiais em diferentes shells

Alguns az dt comandos 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 em seu shell de escolha.

Bash

Use estas dicas de caracteres especiais para ambientes Bash.

Consultas

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

Aqui está um exemplo de como consultar um gêmeo digital com um comando CLI no ambiente 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 estas dicas de caracteres especiais para ambientes do PowerShell.

JSON integrado

Alguns comandos, como az dt twin create, permitem que você insira informações de gêmeos na forma de JSON embutido. Ao inserir JSON embutido no ambiente do PowerShell, escape os 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 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}'

Sugestão

Muitos dos comandos que suportam JSON em linha também aceitam a entrada como um caminho para um ficheiro, o que pode ajudá-lo a evitar requisitos de texto específicos do shell.

Consultas

Em muitas consultas de gémeos, o caractere $ é utilizado para referenciar a propriedade $dtId de um gémeo. Ao usar o comando az dt twin query para consultar em um ambiente PowerShell, escape o $ caractere com um caractere backtick.

Aqui está um exemplo de consulta para um gêmeo com um comando 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 estas dicas de caracteres especiais para o CMD local do Windows.

JSON integrado

Alguns comandos, como az dt twin create, permitem que você insira informações de gêmeos na forma de JSON embutido. Ao inserir JSON inline numa janela CMD local do Windows, coloque o valor do parâmetro entre aspas duplas (") em vez de aspas simples (') e escape os 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 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}"

Sugestão

Muitos dos comandos que suportam JSON em linha também aceitam a entrada como um caminho para um ficheiro, o que pode ajudá-lo a evitar requisitos de texto específicos do shell.

Próximos passos

Explore a CLI e seu conjunto completo de comandos através dos documentos de referência:

  • Last updated on