Conjunto de comandos da CLI do Azure Digital Twins

  • Artigo

Além de gerir a instância do Azure Digital Twins no portal do Azure, o Azure Digital Twins também tem um conjunto de comandos para a CLI do Azure que pode utilizar para realizar a maioria das ações importantes com o serviço. Este artigo aborda o conjunto de comandos da CLI do Azure para o Azure Digital Twins, incluindo as respetivas utilizações, como obtê-lo e os requisitos para utilizá-lo.

Algumas das ações que pode realizar com o conjunto de comandos incluem:

  • Gerir uma instância do Azure Digital Twins
  • Gerir modelos
  • Gerir duplos digitais
  • Gerir relações de duplos
  • Configurar pontos finais
  • Gerir rotas
  • Configurar a segurança através do controlo de acesso baseado em funções do Azure (RBAC do Azure)

O conjunto de comandos chama-se az dte faz parte da extensão do Azure IoT para a CLI do Azure. Pode ver a lista completa de comandos e a respetiva utilização como parte da documentação de referência do az iot conjunto de comandos: az dt command reference.

Utilizações (implementar e validar)

Para além da gestão geral da sua instância, a CLI também é uma ferramenta útil para implementação e validação.

  • Os comandos do plano de controlo podem ser utilizados para tornar a implementação de uma nova instância repetível ou automatizada.
  • Os comandos do plano de dados podem ser utilizados para verificar rapidamente os valores na sua instância e verificar se as operações foram concluídas conforme 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), pelo que deve seguir estes passos para garantir que tem a extensão mais recente azure-iot com os az dt comandos.

Requisitos de versão da CLI

Se estiver a utilizar a CLI do Azure com o PowerShell, a versão da CLI do Azure deve ser a 2.3.1 ou superior como requisito do pacote de extensão.

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, veja Instalar a CLI do Azure.

Obter a extensão

A CLI do Azure irá pedir-lhe automaticamente para instalar a extensão na primeira utilização de um comando que a exija.

Caso contrário, pode utilizar o seguinte comando para instalar a extensão em qualquer altura (ou atualizá-la se se verificar que já tem uma versão mais antiga). O comando pode ser executado na Cloud Shell do Azure ou numa CLI do Azure local.

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

Utilizar carateres especiais em shells diferentes

Alguns az dt comandos utilizam carateres especiais que podem ter de ser escapados para análise adequada em determinados ambientes de shell. Utilize as sugestões nesta secção para o ajudar a saber quando fazê-lo na sua shell à sua escolha.

Bash

Utilize estas sugestões de carateres especiais para ambientes bash.

Consultas

Em muitas consultas de duplos, o $ caráter é utilizado para referenciar a $dtId propriedade de um duplo duplo. Ao utilizar o comando de consulta az dt twin para consultar no ambiente Cloud Shell Bash, escape o $ caráter com uma barra invertida (\).

Eis um exemplo de consulta de um duplo duplo com um comando da 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

Utilize estas sugestões de carateres especiais para ambientes do PowerShell.

Inline JSON

Alguns comandos, como az dt twin create, permitem-lhe introduzir informações de duplos sob a forma de JSON inline. Ao introduzir JSON inline no ambiente do PowerShell, escape os carateres de aspas duplas (") dentro do JSON com uma barra invertida (\).

Eis um exemplo de criação de um duplo duplo 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 suportam JSON inline também suportam a entrada como um caminho de ficheiro, o que pode ajudá-lo a evitar requisitos de texto específicos da shell.

Consultas

Em muitas consultas de duplos, o $ caráter é utilizado para referenciar a $dtId propriedade de um duplo duplo. Ao utilizar o comando de consulta az dt twin para consultar num ambiente do PowerShell, escape o $ caráter com um caráter de acento anterior.

Eis um exemplo de consulta de um duplo duplo 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

Utilize estas sugestões de carateres especiais para o CMD do Windows local.

Inline JSON

Alguns comandos, como az dt twin create, permitem-lhe introduzir informações de duplos sob a forma de JSON inline. Ao introduzir JSON inline numa janela local do WINDOWS CMD, coloque o valor do parâmetro entre aspas (") em vez de plicas (') e escape carateres de aspas duplas dentro do JSON com uma barra invertida (\).

Eis um exemplo de criação de um duplo duplo 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}"

Dica

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

Passos seguintes

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