Partilhar 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 será instalada 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êmeos digitais de uma instância de gêmeos digitais.

Comandos

Name Description Tipo Status
az dt twin relationship create

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

 Extension disponibilidade geral
az dt twin relationship delete

Exclua um relacionamento de gêmeos digitais em uma instância de gêmeos digitais.

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

 Extension disponibilidade geral
az dt twin relationship list

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

 Extension disponibilidade geral
az dt twin relationship show

Mostrar detalhes de uma relação de gêmeos digitais.

 Extension disponibilidade geral
az dt twin relationship update

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

 Extension disponibilidade geral

az dt twin relationship create

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

--properties pode ser JSON embutido ou caminho de arquivo.

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}

Crie 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 Obrigatórios

--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 de relacionamento. Por exemplo: «contém».

--relationship-id -r

Id do relacionamento.

--source --twin-id -t

O gêmeo de origem Id para um relacionamento.

--target --target-twin-id

O Id gêmeo alvo para um relacionamento.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--if-none-match

Indica que a operação create deve falhar se existir um gêmeo existente com a mesma id.

Propriedade Valor
Default value: 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 de instância de gêmeos digitais. Você pode configurar o grupo padrão usando az configure --defaults group={name}.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az dt twin relationship delete

Exclua um relacionamento de gêmeos digitais em uma instância de gêmeos digitais.

az dt twin relationship delete --dt-name --dtn
                               --relationship-id
                               --source --twin-id
                               [--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 o etag.

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

Parâmetros Obrigatórios

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

--source --twin-id -t

O gêmeo de origem Id para um relacionamento.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--etag -e

Valor da tag de entidade. O comando terá êxito se o etag corresponder ao 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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 --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 todos os relacionamentos de gêmeos digitais dentro da instace Digital Twins.

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

Parâmetros Obrigatórios

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 gêmeo de origem Id para um relacionamento.

--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az dt twin relationship list

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

Liste os relacionamentos de entrada de um gêmeo digital.

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

Liste as relações 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 Obrigatórios

--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 gêmeo de origem Id para um relacionamento.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--incoming

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

Propriedade Valor
Default value: False
Valores aceites: false, true
--kind --relationship

Filtrar o resultado pelo tipo de relação.

--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az dt twin relationship show

Mostrar detalhes de uma relação de gêmeos digitais.

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

Exemplos

Mostrar detalhes de uma relação de gêmeos digitais.

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

Parâmetros Obrigatórios

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

--source --twin-id -t

O gêmeo de origem Id para um relacionamento.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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 --dtn
                               --json-patch --patch
                               --relationship-id
                               --source --twin-id
                               [--etag]
                               [--resource-group]

Exemplos

Atualize uma relação de gêmeo digital via 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 um relacionamento de gêmeos digitais 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 via 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 Obrigatórios

--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 de 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 do relacionamento.

--source --twin-id -t

O gêmeo de origem Id para um relacionamento.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--etag -e

Valor da tag de entidade. O comando terá êxito se o etag corresponder ao 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False