az dt twin relationship

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 relationship . Saiba mais sobre extensões.

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

Comandos

Nome	Description	Tipo	Status
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 relationship create

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

--properties pode ser JSON ou caminho de arquivo em linha.

az dt twin relationship create --dt-name
                               --kind
                               --relationship-id
                               --source
                               --target
                               [--if-none-match]
                               [--properties]
                               [--resource-group]

Exemplos

Crie um relacionamento entre dois gêmeos digitais.

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id}

Criar uma relação entre dois gêmeos digitais com a tag if-none-match

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --if-none-match

Crie uma relação com propriedades inicializadas entre dois gêmeos digitais.

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --properties '{"ownershipUser": "me", "ownershipDepartment": "Computer Science"}'

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.

--kind --relationship

Nome ou tipo do relacionamento. Por exemplo: 'contém'.

--relationship-id -r

Id de relacionamento.

--source --twin-id -t

O ID gêmeo de origem para um relacionamento.

--target --target-twin-id

O Id gêmeo alvo para um relacionamento.

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 uma relação de gêmeo digital. Forneça o caminho do arquivo ou JSON embutido.

--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 relationship delete

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

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

Exemplos

Excluir uma relação de gêmeo digital.

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

Exclua uma relação de gêmeo digital usando a etag.

az dt twin relationship delete -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_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.

--relationship-id -r

Id de relacionamento.

--source --twin-id -t

O ID gêmeo de origem para um relacionamento.

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 relationship delete-all

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

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

Exemplos

Exclua todas as relações de gêmeos digitais associadas ao gêmeo.

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

Exclua todos os relacionamentos de gêmeos digitais dentro da instalação de gêmeos digitais.

az dt twin relationship 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>.

--source --twin-id -t

O ID gêmeo de origem para um relacionamento.

--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 relationship list

Liste os relacionamentos de um gêmeo digital.

az dt twin relationship list --dt-name
                             --source
                             [--incoming {false, true}]
                             [--kind]
                             [--resource-group]

Exemplos

Liste relacionamentos de saída de um gêmeo digital.

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id}

Listar relacionamentos de saída de um gêmeo digital e filtrar o relacionamento 'contém'

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains

Listar relacionamentos de entrada de um gêmeo digital.

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --incoming

Liste os relacionamentos de entrada de um gêmeo digital e filtre o relacionamento 'contém'.

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains --incoming

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.

--source --twin-id -t

O ID gêmeo de origem para um relacionamento.

Parâmetros Opcionais

--incoming

Recupera todos os relacionamentos de entrada para um gêmeo digital.

valores aceitos: false, true

valor padrão: False

--kind --relationship

Filtre o resultado pelo tipo de relacionamento.

--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 relationship show

Mostrar detalhes de um relacionamento de gêmeos digitais.

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

Exemplos

Mostrar detalhes de um relacionamento de gêmeos digitais.

az dt twin relationship show -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_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.

--relationship-id -r

Id de relacionamento.

--source --twin-id -t

O ID gêmeo de origem para um relacionamento.

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 relationship update

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

As operações são limitadas para adicionar, substituir e remover.

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

Exemplos

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

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

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

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

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

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

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

az dt twin relationship update -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --relationship contains --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.

--relationship-id -r

Id de relacionamento.

--source --twin-id -t

O ID gêmeo de origem para um relacionamento.

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.