az dt

Nota

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

Gerencie soluções e infraestrutura do Azure Digital Twins.

Comandos

Name	Description	Tipo	Estado
az dt create	Crie ou atualize uma instância do Digital Twins.	Extensão	GA
az dt data-history	Gerencie e configure o histórico de dados.	Extensão	GA
az dt data-history connection	Gerencie e configure conexões de histórico de dados.	Extensão	GA
az dt data-history connection create	Cria uma conexão de histórico de dados entre uma instância do Digital Twins e os recursos suportados.	Extensão	GA
az dt data-history connection create adx	Cria uma conexão de histórico de dados entre uma instância do Digital Twins e um banco de dados do Azure Data Explorer. Requer recursos pré-criados do Azure Data Explorer e do Hub de Eventos.	Extensão	GA
az dt data-history connection delete	Exclua uma conexão de histórico de dados configurada em uma instância do Digital Twins.	Extensão	GA
az dt data-history connection list	Liste todas as conexões do histórico de dados configuradas em uma instância do Digital Twins.	Extensão	GA
az dt data-history connection show	Mostrar detalhes de uma conexão de histórico de dados configurada em uma instância do Digital Twins.	Extensão	GA
az dt data-history connection wait	Aguarde até que uma operação em uma conexão de histórico de dados seja concluída.	Extensão	GA
az dt delete	Exclua uma instância existente do Digital Twins.	Extensão	GA
az dt endpoint	Gerencie e configure pontos de extremidade de instância do Digital Twins.	Extensão	GA
az dt endpoint create	Adicione pontos de extremidade de saída a uma instância do Digital Twins.	Extensão	GA
az dt endpoint create eventgrid	Adiciona um ponto de extremidade EventGrid Topic a uma instância do Digital Twins. Requer recurso pré-criado.	Extensão	GA
az dt endpoint create eventhub	Adiciona um ponto de extremidade do EventHub a uma instância do Digital Twins.	Extensão	GA
az dt endpoint create servicebus	Adiciona um ponto de extremidade ServiceBus Topic a uma instância do Digital Twins.	Extensão	GA
az dt endpoint delete	Remova um ponto de extremidade de uma instância do Digital Twins.	Extensão	GA
az dt endpoint list	Liste todos os pontos de extremidade de saída configurados em uma instância do Digital Twins.	Extensão	GA
az dt endpoint show	Mostrar detalhes de um ponto de extremidade configurado em uma instância do Digital Twins.	Extensão	GA
az dt endpoint wait	Aguarde até que uma operação de ponto de extremidade seja concluída.	Extensão	GA
az dt identity	Gerencie identificações de uma instância do Digital Twins.	Extensão	GA
az dt identity assign	Atribua identidades gerenciadas a uma instância do Digital Twins.	Extensão	GA
az dt identity remove	Remova identidades gerenciadas de uma instância do Digital Twins.	Extensão	GA
az dt identity show	Mostrar as propriedades de identidade de uma instância de Digital Twins.	Extensão	GA
az dt job	Gerencie e configure trabalhos para uma instância de gêmeo digital.	Extensão	GA
az dt job deletion	Gerencie e configure trabalhos para excluir dados de modelos, gêmeos e relacionamentos em uma instância de gêmeo digital.	Extensão	GA
az dt job deletion create	Crie e execute um trabalho de exclusão em uma instância de gêmeo digital.	Extensão	GA
az dt job deletion list	Liste todos os trabalhos de exclusão executados em uma instância de gêmeos digitais.	Extensão	GA
az dt job deletion show	Mostrar detalhes de um trabalho de exclusão executado em uma instância de gêmeos digitais.	Extensão	GA
az dt job import	Gerencie e configure trabalhos para importar dados de modelos, gêmeos e relacionamentos para uma instância de gêmeo digital.	Extensão	GA
az dt job import cancel	Cancele um trabalho de importação de dados executado em uma instância de gêmeos digitais.	Extensão	GA
az dt job import create	Crie e execute um trabalho de importação de dados em uma instância de gêmeo digital.	Extensão	GA
az dt job import delete	Exclua um trabalho de importação de dados executado em uma instância de gêmeos digitais.	Extensão	GA
az dt job import list	Liste todos os trabalhos de importação de dados executados em uma instância de gêmeos digitais.	Extensão	GA
az dt job import show	Mostrar detalhes de um trabalho de importação de dados executado em uma instância de gêmeos digitais.	Extensão	GA
az dt list	Liste a coleção de instâncias do Digital Twins por assinatura ou grupo de recursos.	Extensão	GA
az dt model	Gerencie modelos e definições DTDL em uma instância de Digital Twins.	Extensão	GA
az dt model create	Carrega um ou mais modelos.	Extensão	GA
az dt model delete	Exclua um modelo. Um modelo só pode ser excluído se nenhum outro modelo fizer referência a ele.	Extensão	GA
az dt model delete-all	Exclua todos os modelos em uma instância do Digital Twins.	Extensão	GA
az dt model list	Listar metadados, definições e dependências do modelo.	Extensão	GA
az dt model show	Recupere um modelo de destino ou uma definição de modelo.	Extensão	GA
az dt model update	Atualiza os metadados de um modelo. Atualmente, um modelo só pode ser descomissionado.	Extensão	GA
az dt network	Gerencie a configuração de rede do Digital Twins, incluindo links privados e conexões de ponto final.	Extensão	GA
az dt network private-endpoint	Gerencie endpoints privados de instâncias do Digital Twins.	Extensão	GA
az dt network private-endpoint connection	Gerencie conexões de ponto final privado de instância do Digital Twins.	Extensão	GA
az dt network private-endpoint connection delete	Exclua uma conexão de ponto final privado associada à instância Digital Twins.	Extensão	GA
az dt network private-endpoint connection list	Liste conexões de ponto de extremidade privado associadas à instância Digital Twins.	Extensão	GA
az dt network private-endpoint connection set	Defina o estado de uma conexão de ponto de extremidade privado associada à instância Digital Twins.	Extensão	GA
az dt network private-endpoint connection show	Mostrar uma conexão de ponto de extremidade privado associada à instância Digital Twins.	Extensão	GA
az dt network private-endpoint connection wait	Aguarde até que uma operação em uma conexão de ponto final privado seja concluída.	Extensão	GA
az dt network private-link	Gerencie operações de link privado de instâncias de gêmeos digitais.	Extensão	GA
az dt network private-link list	Liste links privados associados à instância Digital Twins.	Extensão	GA
az dt network private-link show	Mostrar um link privado associado à instância.	Extensão	GA
az dt reset	Redefina uma instância existente do Digital Twins excluindo ativos associados. Atualmente só suporta a exclusão de modelos e gêmeos.	Extensão	Preterido
az dt role-assignment	Gerencie atribuições de função RBAC para uma instância do Digital Twins.	Extensão	GA
az dt role-assignment create	Atribua um usuário, grupo ou entidade de serviço a uma função em relação a uma instância do Digital Twins.	Extensão	GA
az dt role-assignment delete	Remova uma atribuição de função principal de usuário, grupo ou serviço de uma instância do Digital Twins.	Extensão	GA
az dt role-assignment list	Liste as atribuições de função existentes de uma instância do Digital Twins.	Extensão	GA
az dt route	Gerencie e configure rotas de eventos.	Extensão	GA
az dt route create	Adicione uma rota de evento a uma instância do Digital Twins.	Extensão	GA
az dt route delete	Remova uma rota de evento de uma instância do Digital Twins.	Extensão	GA
az dt route list	Liste as rotas de eventos configuradas de uma instância do Digital Twins.	Extensão	GA
az dt route show	Mostrar detalhes de uma rota de evento configurada em uma instância do Digital Twins.	Extensão	GA
az dt show	Mostrar uma instância existente do Digital Twins.	Extensão	GA
az dt twin	Gerencie e configure os gêmeos digitais de uma instância do Digital Twins.	Extensão	GA
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 via 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 este gémeo já devem ser eliminadas.	Extensão	GA
az dt twin delete-all	Exclui todos os gêmeos digitais dentro de uma instância de gêmeos digitais, incluindo todos os relacionamentos para esses gêmeos.	Extensão	GA
az dt twin query	Consulte os gêmeos digitais de uma instância. Permite atravessar relações e filtrar por valores de propriedade.	Extensão	GA
az dt twin relationship	Gerencie e configure 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 de destino.	Extensão	GA
az dt twin relationship delete	Exclua um relacionamento de gêmeos digitais 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 as relações de um gêmeo digital.	Extensão	GA
az dt twin relationship show	Mostrar detalhes de uma relação 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 do Digital Twins.	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 será 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 wait	Aguarde até que uma operação em uma instância do Digital Twins seja concluída.	Extensão	GA

az dt create

Crie ou atualize uma instância do Digital Twins.

az dt create --dt-name
             --resource-group
             [--assign-identity {false, true}]
             [--location]
             [--mi-system-assigned {false, true}]
             [--mi-user-assigned]
             [--no-wait]
             [--pna {Disabled, Enabled}]
             [--role]
             [--scopes]
             [--tags]

Exemplos

Crie uma instância no grupo de recursos de destino usando o local do grupo de recursos.

az dt create -n {instance_name} -g {resouce_group}

Crie uma instância no grupo de recursos de destino com local e tags especificados.

az dt create -n {instance_name} -g {resouce_group} -l westus --tags a=b c=d

Crie uma instância no grupo de recursos de destino com uma identidade gerenciada pelo sistema.

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned

Crie uma instância no grupo de recursos de destino com uma identidade gerenciada pelo usuário.

az dt create -n {instance_name} -g {resouce_group} --mi-user-assigned {resource_id}

Crie uma instância no grupo de recursos de destino com uma identidade gerenciada pelo sistema e várias identidades gerenciadas pelo usuário.

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --mi-user-assigned {resource_id} {resource_id}

Crie uma instância no grupo de recursos de destino com uma identidade gerenciada pelo sistema e, em seguida, atribua a identidade a um ou mais escopos (separados por espaço) com a função de Colaborador.

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic"

Crie uma instância no grupo de recursos de destino com uma identidade gerenciada pelo sistema e, em seguida, atribua a identidade a um ou mais escopos com uma função especificada personalizada.

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic" --role MyCustomRole

Atualize uma instância no grupo de recursos de destino com novos valores de tag e desabilite o acesso à rede pública.

az dt create -n {instance_name} -g {resouce_group} --tags env=prod --public-network-access Disabled

Parâmetros Obrigatórios

--dt-name --dtn -n

Nome da instância do Digital Twins.

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

--assign-identity

Preterido

O argumento 'assign_identity' foi preterido e será removido em uma versão futura. Em vez disso, use '--mi-system-assigned'.

Atribua uma identidade gerada pelo sistema à instância Digital Twins.

valores aceites: false, true

--location -l

Localização da instância do Digital Twins. Se nenhum local for fornecido, o local do grupo de recursos será usado. Você pode configurar o local padrão usando az configure --defaults location=<name>.

--mi-system-assigned

Atribua uma identidade gerada pelo sistema a esta instância do Digital Twins.

valores aceites: false, true

--mi-user-assigned

IDs de recursos de identidade de usuário separados por espaço para adicionar à instância Digital Twins.

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False

--pna --public-network-access

Determina se a instância Digital Twins pode ser acessada de uma rede pública.

valores aceites: Disabled, Enabled

valor predefinido: Enabled

--role

Nome da função ou ID que a identidade atribuída ao sistema terá.

valor predefinido: Contributor

--scopes

Escopos separados por espaço que a identidade atribuída ao sistema pode acessar. Não pode ser usado com --no-wait.

--tags

Tags de instância do Digital Twins. Saco de propriedades em pares chave-valor com o seguinte formato: a=b c=d.

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az dt delete

Exclua uma instância existente do Digital Twins.

az dt delete --dt-name
             [--no-wait]
             [--resource-group]
             [--yes]

Exemplos

Exclua uma instância arbitrária de forma de bloqueio com um prompt de confirmação.

az dt delete -n {instance_name}

Exclua uma instância arbitrária sem bloqueio ou solicitação.

az dt delete -n {instance_name} -y --no-wait

Parâmetros Obrigatórios

--dt-name --dtn -n

Nome da instância do Digital Twins.

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: 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>.

--yes -y

Não solicite confirmação.

valor predefinido: False

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az dt list

Liste a coleção de instâncias do Digital Twins por assinatura ou grupo de recursos.

az dt list [--resource-group]

Exemplos

Liste todas as instâncias na assinatura atual.

az dt list

Liste todas as instâncias no grupo de recursos de destino e a saída em formato de tabela.

az dt list -g {resource_group} --output table

Liste todas as instâncias na assinatura que atendem a uma condição.

az dt list --query "[?contains(name, 'Production')]"

Conte as instâncias que atendem à condição.

az dt list --query "length([?contains(name, 'Production')])"

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

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az dt reset

Preterido

Este comando foi preterido e será removido em uma versão futura. Use 'az dt job delete-all create' em vez disso.

Redefina uma instância existente do Digital Twins excluindo ativos associados. Atualmente só suporta a exclusão de modelos e gêmeos.

az dt reset --dt-name
            [--resource-group]
            [--yes]

Exemplos

Redefina todos os ativos para uma instância do Digital Twins.

az dt reset -n {instance_name}

Parâmetros Obrigatórios

--dt-name --dtn -n

Nome da instância do Digital Twins.

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 predefinido: False

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az dt show

Mostrar uma instância existente do Digital Twins.

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

Exemplos

Mostrar uma instância.

az dt show -n {instance_name}

Mostrar uma instância e projetar determinadas propriedades.

az dt show -n {instance_name} --query "{Endpoint:hostName, Location:location}"

Parâmetros Obrigatórios

--dt-name --dtn -n

Nome da instância do Digital Twins.

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

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az dt wait

Aguarde até que uma operação em uma instância do Digital Twins seja concluída.

az dt wait --dt-name
           [--created]
           [--custom]
           [--deleted]
           [--exists]
           [--interval]
           [--resource-group]
           [--timeout]

Exemplos

Aguarde até que uma instância arbitrária seja criada.

az dt wait -n {instance_name} --created

Aguarde até que uma instância existente seja excluída.

az dt wait -n {instance_name} --deleted

Aguarde até que a propriedade publicNetworkAccess de uma instância existente esteja definida como Enabled

az dt wait -n {instance_name} --custom "publicNetworkAccess=='Enabled'"

Parâmetros Obrigatórios

--dt-name --dtn -n

Nome da instância do Digital Twins.

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

valor predefinido: False

--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor predefinido: False

--exists

Aguarde até que o recurso exista.

valor predefinido: False

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30

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

--timeout

Espera máxima em segundos.

valor predefinido: 3600

Parâmetros de Globais

--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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