Compartilhar via


az dt twin

Note

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.67.0 ou superior). A extensão instalará 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 dos Gêmeos Digitais.

Comandos

Nome Description Tipo Status
az dt twin component

Mostrar e atualizar os componentes do gêmeo digital de uma instância dos Gêmeos Digitais.

Extension GA
az dt twin component show

Mostrar detalhes de um componente de gêmeo digital.

Extension GA
az dt twin component update

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

Extension GA
az dt twin create

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

Extension 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.

Extension GA
az dt twin delete-all

Exclui todos os gêmeos digitais em uma instância dos Gêmeos Digitais, incluindo todas as relações desses gêmeos.

Extension GA
az dt twin query

Consulte os gêmeos digitais de uma instância. Permite a passagem de relações e a filtragem por valores de propriedade.

Extension GA
az dt twin relationship

Gerencie e configure as relações de gêmeo digital de uma instância dos Gêmeos Digitais.

Extension GA
az dt twin relationship create

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

Extension GA
az dt twin relationship delete

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

Extension GA
az dt twin relationship delete-all

Exclui todas as relações de gêmeo digital em uma instância dos Gêmeos Digitais, incluindo relações de entrada.

Extension GA
az dt twin relationship list

Listar as relações de um gêmeo digital.

Extension GA
az dt twin relationship show

Mostrar detalhes de uma relação de gêmeo digital.

Extension GA
az dt twin relationship update

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

Extension GA
az dt twin show

Mostrar os detalhes de um gêmeo digital.

Extension GA
az dt twin telemetry

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

Extension 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.

Extension GA
az dt twin update

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

Extension GA

az dt twin create

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

--properties can be inline JSON or file path. Observação: --as propriedades são necessárias para gêmeos que contêm componentes.

az dt twin create --dt-name --dtn
                  --dtmi --model-id
                  --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 de um modelo existente (criado anteriormente) com marca 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 componente de modelos existentes (criados anteriormente). Componente de instanciação 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 componente 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 dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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

ID do modelo dos Gêmeos Digitais. Exemplo: dtmi:com:example:Room;2.

--twin-id -t

A ID do gêmeo digital.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--if-none-match

Indica que a operação de criação deve falhar se houver um gêmeo existente com a mesma ID.

Propriedade Valor
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 da instância dos Gêmeos Digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 --dtn
                  --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 a 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 dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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

A ID do gêmeo digital.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--etag -e

Valor da marca de entidade. O comando terá êxito se a etag corresponder à etag atual do recurso.

--resource-group -g

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az dt twin delete-all

Exclui todos os gêmeos digitais em uma instância dos Gêmeos Digitais, incluindo todas as relações desses gêmeos.

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

Exemplos

Exclua todos os gêmeos digitais. Todas as relações que referenciam os gêmeos também serão excluídas.

az dt twin delete-all -n {instance_or_hostname}

Parâmetros Exigidos

--dt-name --dtn -n

Nome da instância ou nome do host dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-group -g

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

--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az dt twin query

Consulte os gêmeos digitais de uma instância. Permite a passagem de relações e a filtragem por valores de propriedade.

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

az dt twin query --dt-name --dtn
                 --query-command
                 [--cost --show-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 o 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 dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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 de usuário a ser executada.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--cost --show-cost

Calcula e mostra a cobrança da consulta.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--resource-group -g

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az dt twin show

Mostrar os detalhes de um gêmeo digital.

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

Exemplos

Mostrar 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 dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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

A ID do gêmeo digital.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--resource-group -g

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az dt twin update

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

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

az dt twin update --dt-name --dtn
                  --json-patch --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 por meio da especificação de patch JSON e usando a 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 dos Gêmeos Digitais. Se um nome de instância for fornecido, a assinatura do usuário será consultada pela primeira vez 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 patch JSON. Atualizações para valores de propriedade e elementos $model podem ocorrer 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

A ID do gêmeo digital.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--etag -e

Valor da marca de entidade. O comando terá êxito se a etag corresponder à etag atual do recurso.

--resource-group -g

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False