az iot ops asset
Note
Essa referência faz parte da extensão azure-iot-ops 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 iot ops asset . Saiba mais sobre extensões.
Gerenciamento de ativos.
Para obter mais informações sobre o gerenciamento de ativos, consulte aka.ms/asset-overview.
Comandos
| Nome | Description | Tipo | Status |
|---|---|---|---|
| az iot ops asset create |
Crie um ativo. |
Extension | GA |
| az iot ops asset dataset |
Gerencie conjuntos de dados em um ativo. |
Extension | GA |
| az iot ops asset dataset list |
Listar conjuntos de dados em um ativo. |
Extension | GA |
| az iot ops asset dataset point |
Gerencie pontos de dados em um conjunto de dados de ativos. |
Extension | GA |
| az iot ops asset dataset point add |
Adicione um ponto de dados a um conjunto de dados de ativos. |
Extension | GA |
| az iot ops asset dataset point export |
Exporte pontos de dados em um conjunto de dados de ativos. |
Extension | GA |
| az iot ops asset dataset point import |
Importe pontos de dados em um conjunto de dados de ativos. |
Extension | GA |
| az iot ops asset dataset point list |
Listar pontos de dados em um conjunto de dados de ativos. |
Extension | GA |
| az iot ops asset dataset point remove |
Remova um ponto de dados em um conjunto de dados de ativos. |
Extension | GA |
| az iot ops asset dataset show |
Mostrar um conjunto de dados dentro de um ativo. |
Extension | GA |
| az iot ops asset delete |
Exclua um ativo. |
Extension | GA |
| az iot ops asset endpoint |
Gerencie perfis de endpoint de ativos. |
Extension | GA |
| az iot ops asset endpoint create |
Crie perfis de endpoint de ativos. |
Extension | GA |
| az iot ops asset endpoint create opcua |
Crie um perfil de ponto de extremidade de ativo para um conector OPCUA. |
Extension | GA |
| az iot ops asset endpoint delete |
Exclua um perfil de endpoint de ativo. |
Extension | GA |
| az iot ops asset endpoint query |
Consulte o Resource Graph para obter perfis de endpoint de ativos. |
Extension | GA |
| az iot ops asset endpoint show |
Mostrar um perfil de endpoint de ativo. |
Extension | GA |
| az iot ops asset endpoint update |
Atualize um perfil de endpoint de ativo. |
Extension | GA |
| az iot ops asset event |
Gerencie eventos em um ativo. |
Extension | GA |
| az iot ops asset event add |
Adicione um evento a um ativo. |
Extension | GA |
| az iot ops asset event export |
Exportar eventos em um ativo. |
Extension | GA |
| az iot ops asset event import |
Importe eventos em um ativo. |
Extension | GA |
| az iot ops asset event list |
Listar eventos em um ativo. |
Extension | GA |
| az iot ops asset event remove |
Remova um evento em um ativo. |
Extension | GA |
| az iot ops asset query |
Consulte o Resource Graph para ativos. |
Extension | GA |
| az iot ops asset show |
Mostrar um ativo. |
Extension | GA |
| az iot ops asset update |
Atualize um ativo. |
Extension | 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 --ep
--instance
--name
--resource-group
[--attr --custom-attribute]
[--dataset-publish-int --dpi]
[--dataset-queue-size --dqs]
[--dataset-sample-int --dsi]
[--description]
[--disable {false, true}]
[--display-name --dn]
[--documentation-uri --du]
[--eai --external-asset-id]
[--ef --event-file]
[--epi --event-publish-int]
[--eqs --event-queue-size]
[--esi --event-sample-int]
[--event]
[--hardware-revision --hr]
[--ig --instance-resource-group]
[--location]
[--manufacturer]
[--manufacturer-uri --mu]
[--model]
[--pc --product-code]
[--serial-number --sn]
[--software-revision --sr]
[--tags]
[--topic-path --tp]
[--topic-retain --tr {Keep, Never}]
Exemplos
Crie um ativo usando a instância especificada 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 especificada 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 desativado 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 Exigidos
Nome do perfil do ponto de extremidade do ativo.
Nome da instância ao qual associar o ativo criado.
Nome do ativo.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
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.
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.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Intervalo de publicação padrão para conjuntos de dados.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Dataset Default Arguments |
| Valor padrão: | 1000 |
Tamanho da fila padrão para conjuntos de dados.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Dataset Default Arguments |
| Valor padrão: | 1 |
Intervalo de amostragem padrão (em milissegundos) para conjuntos de dados.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Dataset Default Arguments |
| Valor padrão: | 500 |
Description.
Desative um ativo.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
| Valores aceitos: | false, true |
Nome de exibição.
URI da documentação.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
ID do ativo externo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Caminho do arquivo que contém os eventos. Os seguintes tipos de arquivo são suportados: json, csv, yaml.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Arguments |
Intervalo de publicação padrão para eventos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Default Arguments |
| Valor padrão: | 1000 |
Tamanho da fila padrão para eventos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Default Arguments |
| Valor padrão: | 1 |
Intervalo de amostragem padrão (em milissegundos) para eventos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Default Arguments |
| Valor padrão: | 500 |
Pares chave=valor separados por espaço correspondentes às propriedades do evento a ser criado. Há suporte para os seguintes valores de chave: event_notifier (obrigatório), name (obrigatório), observability_mode (nenhum ou log), sampling_interval (int), queue_size (int). --event pode ser usado 1 ou mais vezes. Examine os exemplos de ajuda para o uso completo do parâmetro.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Arguments |
Revisão de hardware.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Grupo de recursos da instância. Se não for fornecido, o grupo de recursos de ativos será usado.
Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.
Manufacturer.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
URI do fabricante.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Model.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Código do produto.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Número de série.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Revisão de software.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Tags de recursos de ativos. Recipiente de propriedades em pares de valores-chave com o seguinte formato: a=b c=d.
Caminho do tópico padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MQTT Topic Default Arguments |
Política de retenção de tópico padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MQTT Topic Default Arguments |
| Valores aceitos: | Keep, Never |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot ops asset delete
Exclua um ativo.
az iot ops asset delete --name
--resource-group
Exemplos
Exclua um ativo.
az iot ops asset delete --name myasset -g myresourcegroup
Parâmetros Exigidos
Nome do ativo.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot ops asset query
Consulte o Resource Graph para ativos.
az iot ops asset query [--cq --custom-query]
[--description]
[--disabled {false, true}]
[--display-name --dn]
[--documentation-uri --du]
[--eai --external-asset-id]
[--endpoint-profile --ep]
[--hardware-revision --hr]
[--ig --instance-resource-group]
[--instance]
[--location]
[--manufacturer]
[--manufacturer-uri --mu]
[--model]
[--name]
[--pc --product-code]
[--resource-group]
[--serial-number --sn]
[--software-revision --sr]
[--topic-path --tp]
[--topic-retain --tr {Keep, Never}]
Exemplos
Consultar ativos desativados em um determinado grupo de recursos.
az iot ops asset query -g myresourcegroup --disabled
Consulte ativos que tenham 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
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.
Consulta personalizada a ser usada. Todos os outros argumentos de consulta serão ignorados.
Description.
Estado do ativo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
| Valores aceitos: | false, true |
Nome de exibição.
URI da documentação.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
ID do ativo externo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Nome do perfil do ponto de extremidade do ativo.
Revisão de hardware.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Grupo de recursos da instância. Se não for fornecido, o grupo de recursos de ativos será usado.
Nome da instância ao qual associar o ativo criado.
Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.
Manufacturer.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
URI do fabricante.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Model.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Nome do ativo.
Código do produto.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Número de série.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Revisão de software.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Caminho do tópico padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MQTT Topic Default Arguments |
Política de retenção de tópico padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MQTT Topic Default Arguments |
| Valores aceitos: | Keep, Never |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot ops asset show
Mostrar um ativo.
az iot ops asset show --name
--resource-group
Exemplos
Mostre os detalhes de um ativo.
az iot ops asset show --name myasset -g myresourcegroup
Parâmetros Exigidos
Nome do ativo.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot ops asset update
Atualize um ativo.
Para atualizar conjuntos de dados e eventos, use os grupos az iot ops asset dataset de comandos e az iot ops asset event respectivamente.
az iot ops asset update --name
--resource-group
[--attr --custom-attribute]
[--dataset-publish-int --dpi]
[--dataset-queue-size --dqs]
[--dataset-sample-int --dsi]
[--description]
[--disable {false, true}]
[--display-name --dn]
[--documentation-uri --du]
[--epi --event-publish-int]
[--eqs --event-queue-size]
[--esi --event-sample-int]
[--hardware-revision --hr]
[--manufacturer]
[--manufacturer-uri --mu]
[--model]
[--pc --product-code]
[--serial-number --sn]
[--software-revision --sr]
[--tags]
[--topic-path --tp]
[--topic-retain --tr {Keep, Never}]
Exemplos
Atualize o conjunto de dados de um ativo e os padrões de evento.
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 Exigidos
Nome do ativo.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
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.
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 "".
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Intervalo de publicação padrão para conjuntos de dados.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Dataset Default Arguments |
Tamanho da fila padrão para conjuntos de dados.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Dataset Default Arguments |
Intervalo de amostragem padrão (em milissegundos) para conjuntos de dados.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Dataset Default Arguments |
Description.
Desative um ativo.
| Propriedade | Valor |
|---|---|
| Valores aceitos: | false, true |
Nome de exibição.
URI da documentação.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Intervalo de publicação padrão para eventos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Default Arguments |
Tamanho da fila padrão para eventos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Default Arguments |
Intervalo de amostragem padrão (em milissegundos) para eventos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Event Default Arguments |
Revisão de hardware.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Manufacturer.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
URI do fabricante.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Model.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Código do produto.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Número de série.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Revisão de software.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Additional Info Arguments |
Tags de recursos de ativos. Recipiente de propriedades em pares de valores-chave com o seguinte formato: a=b c=d.
Caminho do tópico padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MQTT Topic Default Arguments |
Política de retenção de tópico padrão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | MQTT Topic Default Arguments |
| Valores aceitos: | Keep, Never |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |