az dt twin

  • Referência

Observação

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.37.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az dt twin . Saiba mais sobre extensões.

Gerencie e configure os gêmeos digitais de uma instância de Gêmeos Digitais.

Comandos

Nome Description Tipo Status
az dt twin component

Mostrar e atualizar os componentes de gêmeos digitais de uma instância de Gêmeos Digitais.

 Extensão GA
az dt twin component show

Mostrar detalhes de um componente de gêmeo digital.

 Extensão GA
az dt twin component update

Atualize um componente de gêmeo digital por meio da especificação de patch JSON.

 Extensão GA
az dt twin create

Crie um gêmeo digital em uma instância.

 Extensão GA
az dt twin delete

Remova um gêmeo digital. Todas as relações que fazem referência a esse gêmeo já devem ser excluídas.

 Extensão GA
az dt twin delete-all

Exclui todos os gêmeos digitais em uma instância de Gêmeos Digitais, incluindo todos os relacionamentos desses gêmeos.

 Extensão GA
az dt twin query

Consulte os gêmeos digitais de uma instância. Permite atravessar relacionamentos e filtrar por valores de propriedade.

 Extensão GA
az dt twin relationship

Gerenciar e configurar as relações de gêmeos digitais de uma instância de Gêmeos Digitais.

 Extensão GA
az dt twin relationship create

Crie uma relação entre gêmeos digitais de origem e destino.

 Extensão GA
az dt twin relationship delete

Exclua uma relação de gêmeo digital em uma instância de Gêmeos Digitais.

 Extensão GA
az dt twin relationship delete-all

Exclui todos os relacionamentos de gêmeos digitais em uma instância de Gêmeos Digitais, incluindo relacionamentos de entrada.

 Extensão GA
az dt twin relationship list

Liste os relacionamentos de um gêmeo digital.

 Extensão GA
az dt twin relationship show

Mostrar detalhes de um relacionamento de gêmeos digitais.

 Extensão GA
az dt twin relationship update

Atualiza as propriedades de um relacionamento entre dois gêmeos digitais por meio da especificação de patch JSON.

 Extensão GA
az dt twin show

Mostre os detalhes de um gêmeo digital.

 Extensão GA
az dt twin telemetry

Teste e valide as rotas de evento e os pontos de extremidade de uma instância de Gêmeos Digitais.

 Extensão GA
az dt twin telemetry send

Envia telemetria em nome de um gêmeo digital. Se o caminho do componente for fornecido, a telemetria emitida estará em nome do componente.

 Extensão GA
az dt twin update

Atualize um gêmeo digital de instância por meio da especificação de patch JSON.

 Extensão GA

az dt twin create

Crie um gêmeo digital em uma instância.

--properties pode ser JSON ou caminho de arquivo em linha. Nota: --properties são necessárias para gêmeos que contêm componentes.

az dt twin create --dt-name
                  --dtmi
                  --twin-id
                  [--if-none-match]
                  [--properties]
                  [--resource-group]

Exemplos

Criar um gêmeo digital de um modelo existente (criado anteriormente).

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}

Crie um gêmeo digital a partir de um modelo existente (criado anteriormente) com a tag if-none-match.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match

Criar um gêmeo digital de um modelo existente (criado anteriormente). Instancie com valores de propriedade.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'

Crie um gêmeo digital com componentes de modelos existentes (criados anteriormente). Instanciar componente com propriedades mínimas.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Thermostat": {
        "$metadata": {},
    }
}'

Crie um gêmeo digital com componentes de modelos existentes (criados anteriormente). Instancie com valores de propriedade.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Temperature": 10.2,
    "Thermostat": {
        "$metadata": {},
        "setPointTemp": 23.12
    }
}'

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.

--dtmi --model-id -m

Modelo de gêmeos digitais Id. Exemplo: dtmi:com:example:Room;2.

--twin-id -t

O gêmeo digital Id.

Parâmetros Opcionais

--if-none-match

Indica que a operação de criação deve falhar se existir um gêmeo existente com o mesmo id.

valor padrão: False
--properties -p

Valores de propriedade inicial para instanciar um gêmeo digital ou componentes relacionados. Forneça o caminho do arquivo ou JSON embutido. As propriedades são necessárias para gêmeos que contêm componentes, no mínimo você deve fornecer um objeto $metadata vazio para cada componente.

--resource-group -g

Grupo de recursos de instância de Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dt twin delete

Remova um gêmeo digital. Todas as relações que fazem referência a esse gêmeo já devem ser excluídas.

az dt twin delete --dt-name
                  --twin-id
                  [--etag]
                  [--resource-group]

Exemplos

Remova um gêmeo digital por Id.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id}

Remova um gêmeo digital por Id usando o etag.

az dt twin delete -n {instance_or_hostname} --twin-id {twin_id} --etag {etag}

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.

--twin-id -t

O gêmeo digital Id.

Parâmetros Opcionais

--etag -e

Valor da tag de entidade. O comando será bem-sucedido se a etag corresponder à etag atual do recurso.

--resource-group -g

Grupo de recursos de instância de Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dt twin delete-all

Exclui todos os gêmeos digitais em uma instância de Gêmeos Digitais, incluindo todos os relacionamentos desses gêmeos.

az dt twin delete-all --dt-name
                      [--resource-group]
                      [--yes]

Exemplos

Exclua todos os gêmeos digitais. Quaisquer relacionamentos que façam referência aos gêmeos também serão excluídos.

az dt twin delete-all -n {instance_or_hostname}

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.

Parâmetros Opcionais

--resource-group -g

Grupo de recursos de instância de Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dt twin query

Consulte os gêmeos digitais de uma instância. Permite atravessar relacionamentos e filtrar por valores de propriedade.

Em muitas consultas de gêmeos, o caractere $ é usado para referenciar a propriedade $dtId de um gêmeo. Em shells bash-like ou powershell, o $ caractere tem significado funcional e deve ser escapado como parte da entrada de consulta. Consulte o documento https://docs.microsoft.com/en-us/azure/digital-twins/concepts-cli de conceitos da CLI do Digital Twins para obter mais informações.

az dt twin query --dt-name
                 --query-command
                 [--cost {false, true}]
                 [--resource-group]

Exemplos

Consultar todos os gêmeos digitais na instância de destino e projetar todos os atributos. Mostrar também o custo em unidades de consulta.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost

Consultar por modelo e projetar todos os atributos.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"

Consulta aproveitando '$dtId' com sintaxe compatível com bash

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

Consulta aproveitando '$dtId' com sintaxe compatível com powershell

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.

--query-command -q

Consulta do usuário a ser executada.

Parâmetros Opcionais

--cost --show-cost

Calcula e mostra a taxa de consulta.

valores aceitos: false, true
valor padrão: False
--resource-group -g

Grupo de recursos de instância de Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dt twin show

Mostre os detalhes de um gêmeo digital.

az dt twin show --dt-name
                --twin-id
                [--resource-group]

Exemplos

Mostre os detalhes de um gêmeo digital.

az dt twin show -n {instance_or_hostname} --twin-id {twin_id}

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.

--twin-id -t

O gêmeo digital Id.

Parâmetros Opcionais

--resource-group -g

Grupo de recursos de instância de Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dt twin update

Atualize um gêmeo digital de instância por meio da especificação de patch JSON.

Atualizações nos valores de propriedade e elementos $model podem acontecer na mesma solicitação. As operações são limitadas para adicionar, substituir e remover.

az dt twin update --dt-name
                  --json-patch
                  --twin-id
                  [--etag]
                  [--resource-group]

Exemplos

Atualize um gêmeo digital por meio da especificação de patch JSON.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Atualize um gêmeo digital via especificação de patch JSON e usando etag.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --etag {etag} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Atualize um gêmeo digital por meio da especificação de patch JSON.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '[
  {"op":"replace", "path":"/Temperature", "value": 20.5},
  {"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'

Atualize um gêmeo digital por meio da especificação de patch JSON definida em um arquivo.

az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch ./my/patch/document.json

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host do Digital Twins. Se um nome de instância for fornecido, a assinatura do usuário será consultada primeiro para que a instância de destino recupere o nome do host. Se um nome de host for fornecido, a consulta de assinatura será ignorada e o valor fornecido será usado para interação subsequente.

--json-patch --patch

Uma especificação de atualização descrita pelo JSON-patch. Atualizações nos valores de propriedade e elementos $model podem acontecer na mesma solicitação. As operações são limitadas para adicionar, substituir e remover. Forneça o caminho do arquivo ou JSON embutido.

--twin-id -t

O gêmeo digital Id.

Parâmetros Opcionais

--etag -e

Valor da tag de entidade. O comando será bem-sucedido se a etag corresponder à etag atual do recurso.

--resource-group -g

Grupo de recursos de instância de Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.