Compartilhar via

az dt twin relationship

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

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

Comandos

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

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

--properties can be inline JSON or file path.

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

Exemplos

Crie uma relação 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 marca 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 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.

--kind --relationship

Nome ou tipo de relação. Por exemplo: 'contains'.

--relationship-id -r

ID da relação.

--source --twin-id -t

A ID do gêmeo de origem para um relacionamento.

--target --target-twin-id

A ID de gêmeo de destino para um relacionamento.

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

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

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

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

Exemplos

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

--relationship-id -r

ID da relação.

--source --twin-id -t

A ID do gêmeo de origem para um relacionamento.

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

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

Exemplos

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

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

Exclua todas as relações de gêmeo digital no instace dos 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 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}.

--source --twin-id -t

A ID do gêmeo de origem para um relacionamento.

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

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

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

Exemplos

Listar relações de saída de um gêmeo digital.

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

Listar relações de saída de um gêmeo digital e filtrar na relação 'contains'

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

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

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

Listar relações de entrada de um gêmeo digital e filtrar na relação 'contains'.

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

--source --twin-id -t

A ID do gêmeo de origem para um relacionamento.

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.

--incoming

Recupera todas as relações de entrada para um gêmeo digital.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--kind --relationship

Filtrar o resultado pelo tipo de relação.

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

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

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

Exemplos

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

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

--relationship-id -r

ID da relação.

--source --twin-id -t

A ID do gêmeo de origem para um relacionamento.

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

Atualiza as propriedades de uma relação 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 --dtn
                               --json-patch --patch
                               --relationship-id
                               --source --twin-id
                               [--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 por meio da especificação de patch JSON e usando a 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 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.

--relationship-id -r

ID da relação.

--source --twin-id -t

A ID do gêmeo de origem para um relacionamento.

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