Partilhar via

az iot ops asset

  • Referência

Observação

Essa referência faz parte da extensão azure-iot-ops para a CLI do Azure (versão 2.53.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot ops asset. Saiba mais sobre extensões.

Gestão de ativos.

Para obter mais informações sobre gestão de ativos, consulte aka.ms/asset-overview.

Comandos

Name Description Tipo Status
az iot ops asset create

Crie um ativo.

 Extensão GA
az iot ops asset dataset

Gerencie conjuntos de dados em um ativo.

 Extensão GA
az iot ops asset dataset list

Listar conjuntos de dados dentro de um ativo.

 Extensão GA
az iot ops asset dataset point

Gerencie pontos de dados em um conjunto de dados de ativos.

 Extensão GA
az iot ops asset dataset point add

Adicione um ponto de dados a um conjunto de dados de ativos.

 Extensão GA
az iot ops asset dataset point export

Exporte pontos de dados em um conjunto de dados de ativos.

 Extensão GA
az iot ops asset dataset point import

Importe pontos de dados em um conjunto de dados de ativos.

 Extensão GA
az iot ops asset dataset point list

Listar pontos de dados em um conjunto de dados de ativos.

 Extensão GA
az iot ops asset dataset point remove

Remova um ponto de dados em um conjunto de dados de ativos.

 Extensão GA
az iot ops asset dataset show

Mostrar um conjunto de dados dentro de um ativo.

 Extensão GA
az iot ops asset delete

Excluir um ativo.

 Extensão GA
az iot ops asset endpoint

Gerencie perfis de ponto de extremidade de ativos.

 Extensão GA
az iot ops asset endpoint create

Crie perfis de ponto de extremidade de ativos.

 Extensão GA
az iot ops asset endpoint create opcua

Crie um perfil de ponto de extremidade de ativo com um conector OPCUA.

 Extensão GA
az iot ops asset endpoint delete

Exclua um perfil de ponto de extremidade de ativo.

 Extensão GA
az iot ops asset endpoint query

Consulte o Gráfico de Recursos para perfis de ponto de extremidade de ativos.

 Extensão GA
az iot ops asset endpoint show

Mostrar um perfil de ponto de extremidade de ativo.

 Extensão GA
az iot ops asset endpoint update

Atualize um perfil de ponto de extremidade de ativo.

 Extensão GA
az iot ops asset event

Gerencie eventos em um ativo.

 Extensão GA
az iot ops asset event add

Adicione um evento a um ativo.

 Extensão GA
az iot ops asset event export

Exportar eventos em um ativo.

 Extensão GA
az iot ops asset event import

Importar eventos em um ativo.

 Extensão GA
az iot ops asset event list

Listar eventos em um ativo.

 Extensão GA
az iot ops asset event remove

Remova um evento em um ativo.

 Extensão GA
az iot ops asset query

Consulte o gráfico de recursos para ativos.

 Extensão GA
az iot ops asset show

Mostrar um ativo.

 Extensão GA
az iot ops asset update

Atualize um ativo.

 Extensão GA

az iot ops asset create

Crie um ativo.

Para obter exemplos de formatos de arquivo, consulte aka.ms/aziotops-assets.

az iot ops asset create --endpoint-profile
                        --instance
                        --name
                        --resource-group
                        [--attr]
                        [--dataset-publish-int]
                        [--dataset-queue-size]
                        [--dataset-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--ef]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--event]
                        [--hardware-revision]
                        [--ig]
                        [--instance-subscription]
                        [--location]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]
                        [--topic-path]
                        [--topic-retain {Keep, Never}]

Exemplos

Crie um ativo usando a instância determinada no mesmo grupo de recursos.

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance

Crie um ativo usando a instância determinada em um grupo de recursos diferente, mas na mesma assinatura. Observe que a Experiência de Operações Digitais pode não exibir o ativo se ele estiver em uma assinatura diferente da instância.

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --instance-resource-group myinstanceresourcegroup

Crie um ativo desabilitado usando um arquivo que contém eventos.

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --event-file /path/to/myasset_events.csv --disable

Crie um ativo com os valores pré-preenchidos fornecidos.

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --event event_notifier=EventNotifier1 name=myEvent1 observability_mode=log sampling_interval=10 queue_size=2 --event event_notifier=EventNotifier2 name=myEvent2 --dataset-publish-int 1250 --dataset-queue-size 2 --dataset-sample-int 30 --event-publish-int 750 --event-queue-size 3 --event-sample-int 50 --description 'Description for a test asset.' --documentation-uri www.contoso.com --external-asset-id 000-000-1234 --hardware-revision 10.0 --product-code XXX100 --software-revision 0.1 --manufacturer Contoso --manufacturer-uri constoso.com --model AssetModel --serial-number 000-000-ABC10 --custom-attribute work_location=factory

Parâmetros Obrigatórios

--endpoint-profile --ep

Nome do perfil do ponto de extremidade do ativo.

--instance

Nome da instância ao qual associar o ativo criado.

--name -n

Nome do ativo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--attr --custom-attribute

Pares chave=valor separados por espaço correspondentes a atributos personalizados adicionais para o ativo. Este parâmetro pode ser usado mais de uma vez.

--dataset-publish-int --dpi

Intervalo de publicação padrão para conjuntos de dados.

Default value: 1000
--dataset-queue-size --dqs

Tamanho de fila padrão para conjuntos de dados.

Default value: 1
--dataset-sample-int --dsi

Intervalo de amostragem padrão (em milissegundos) para conjuntos de dados.

Default value: 500
--description -d

Descrição.

--disable

Desative um ativo.

Valores aceites: false, true
Default value: False
--display-name --dn

Nome para exibição.

--documentation-uri --du

URI de documentação.

--eai --external-asset-id

Id do ativo externo.

--ef --event-file

Caminho do arquivo que contém os eventos. Os seguintes tipos de arquivo são suportados: json, csv, yaml.

--epi --event-publish-int

Intervalo de publicação padrão para eventos.

Default value: 1000
--eqs --event-queue-size

Tamanho de fila padrão para eventos.

Default value: 1
--esi --event-sample-int

Intervalo de amostragem padrão (em milissegundos) para eventos.

Default value: 500
--event

Pares key=value separados por espaço correspondentes às propriedades do evento a ser criado. Os seguintes valores de chave são suportados: event_notifier (obrigatório), name (obrigatório), observability_mode (nenhum ou log), sampling_interval (int), queue_size (int). --evento pode ser usado 1 ou mais vezes. Analise exemplos de ajuda para obter o uso completo de parâmetros.

--hardware-revision --hr

Revisão de hardware.

--ig --instance-resource-group

Grupo de recursos de instância. Se não for fornecido, o grupo de recursos de ativos será usado.

--instance-subscription --is
Preterido

O argumento 'instance_subscription' foi preterido e será removido em uma versão futura.

ID da assinatura da instância. Se não for fornecido, o ID de assinatura do ativo será usado.

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--manufacturer

Fabricante.

--manufacturer-uri --mu

URI do fabricante.

--model

Modelo.

--pc --product-code

Código do produto.

--serial-number --sn

Número de série.

--software-revision --sr

Revisão de software.

--tags

Tags de recursos de ativos. Saco de propriedades em pares chave-valor com o seguinte formato: a=b c=d.

--topic-path --tp

Caminho do tópico padrão.

--topic-retain --tr

Política de retenção de tópico padrão.

Valores aceites: Keep, Never
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
Default value: json
--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.

az iot ops asset delete

Excluir um ativo.

az iot ops asset delete --name
                        --resource-group

Exemplos

Excluir um ativo.

az iot ops asset delete --name myasset -g myresourcegroup

Parâmetros Obrigatórios

--name -n

Nome do ativo.

--resource-group -g

Nome do grupo de recursos. 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
Default value: json
--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.

az iot ops asset query

Consulte o gráfico de recursos para ativos.

az iot ops asset query [--cq]
                       [--description]
                       [--disabled {false, true}]
                       [--display-name]
                       [--documentation-uri]
                       [--eai]
                       [--endpoint-profile]
                       [--hardware-revision]
                       [--ig]
                       [--instance]
                       [--location]
                       [--manufacturer]
                       [--manufacturer-uri]
                       [--model]
                       [--name]
                       [--pc]
                       [--resource-group]
                       [--serial-number]
                       [--software-revision]
                       [--topic-path]
                       [--topic-retain {Keep, Never}]

Exemplos

Consulta de ativos desabilitados em um determinado grupo de recursos.

az iot ops asset query -g myresourcegroup --disabled

Consulta de ativos que têm o modelo, o fabricante e o número de série fornecidos.

az iot ops asset query --model model1 --manufacturer contoso --serial-number 000-000-ABC10

Parâmetros Opcionais

--cq --custom-query

Consulta personalizada a ser usada. Todos os outros argumentos de consulta serão ignorados.

--description -d

Descrição.

--disabled

Estado do ativo.

Valores aceites: false, true
--display-name --dn

Nome para exibição.

--documentation-uri --du

URI de documentação.

--eai --external-asset-id

Id do ativo externo.

--endpoint-profile --ep

Nome do perfil do ponto de extremidade do ativo.

--hardware-revision --hr

Revisão de hardware.

--ig --instance-resource-group

Grupo de recursos de instância. Se não for fornecido, o grupo de recursos de ativos será usado.

--instance

Nome da instância ao qual associar o ativo criado.

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--manufacturer

Fabricante.

--manufacturer-uri --mu

URI do fabricante.

--model

Modelo.

--name -n

Nome do ativo.

--pc --product-code

Código do produto.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--serial-number --sn

Número de série.

--software-revision --sr

Revisão de software.

--topic-path --tp

Caminho do tópico padrão.

--topic-retain --tr

Política de retenção de tópico padrão.

Valores aceites: Keep, Never
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
Default value: json
--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.

az iot ops asset show

Mostrar um ativo.

az iot ops asset show --name
                      --resource-group

Exemplos

Mostrar os detalhes de um ativo.

az iot ops asset show --name myasset -g myresourcegroup

Parâmetros Obrigatórios

--name -n

Nome do ativo.

--resource-group -g

Nome do grupo de recursos. 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
Default value: json
--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.

az iot ops asset update

Atualize um ativo.

Para atualizar conjuntos de dados e eventos, use os grupos de comandos az iot ops asset dataset e az iot ops asset event respectivamente.

az iot ops asset update --name
                        --resource-group
                        [--attr]
                        [--dataset-publish-int]
                        [--dataset-queue-size]
                        [--dataset-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--hardware-revision]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]
                        [--topic-path]
                        [--topic-retain {Keep, Never}]

Exemplos

Atualize o conjunto de dados de um ativo e os padrões de eventos.

az iot ops asset update --name myasset -g myresourcegroup --dataset-publish-int 1250 --dataset-queue-size 2 --dataset-sample-int 30 --event-publish-int 750 --event-queue-size 3 --event-sample-int 50

Atualize a descrição de um ativo, o uri da documentação, a revisão de hardware, o código do produto e a revisão de software.

az iot ops asset update --name myasset -g myresourcegroup --description "Updated test asset description." --documentation-uri www.contoso.com --hardware-revision 11.0 --product-code XXX102 --software-revision 0.2

Atualize o fabricante, o uri do fabricante, o modelo, o número de série e o atributo personalizado de um ativo.

az iot ops asset update --name myasset -g myresourcegroup --manufacturer Contoso --manufacturer-uri constoso2.com --model NewAssetModel --serial-number 000-000-ABC11 --custom-attribute work_location=new_factory --custom-attribute secondary_work_location=factory

Desative um ativo e remova um atributo personalizado chamado "work_site".

az iot ops asset update --name myasset -g myresourcegroup --disable --custom-attribute work_site=""

Parâmetros Obrigatórios

--name -n

Nome do ativo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--attr --custom-attribute

Pares chave=valor separados por espaço correspondentes a atributos personalizados adicionais para o ativo. Este parâmetro pode ser usado mais de uma vez. Para remover um atributo personalizado, defina o valor do atributo como "".

--dataset-publish-int --dpi

Intervalo de publicação padrão para conjuntos de dados.

--dataset-queue-size --dqs

Tamanho de fila padrão para conjuntos de dados.

--dataset-sample-int --dsi

Intervalo de amostragem padrão (em milissegundos) para conjuntos de dados.

--description -d

Descrição.

--disable

Desative um ativo.

Valores aceites: false, true
--display-name --dn

Nome para exibição.

--documentation-uri --du

URI de documentação.

--epi --event-publish-int

Intervalo de publicação padrão para eventos.

--eqs --event-queue-size

Tamanho de fila padrão para eventos.

--esi --event-sample-int

Intervalo de amostragem padrão (em milissegundos) para eventos.

--hardware-revision --hr

Revisão de hardware.

--manufacturer

Fabricante.

--manufacturer-uri --mu

URI do fabricante.

--model

Modelo.

--pc --product-code

Código do produto.

--serial-number --sn

Número de série.

--software-revision --sr

Revisão de software.

--tags

Tags de recursos de ativos. Saco de propriedades em pares chave-valor com o seguinte formato: a=b c=d.

--topic-path --tp

Caminho do tópico padrão.

--topic-retain --tr

Política de retenção de tópico padrão.

Valores aceites: Keep, Never
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
Default value: json
--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.