Compartilhar via

az iot ops asset

  • Versão Prévia
  • 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.

O grupo de comandos 'iot ops' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerenciar ativos.

Comandos

Nome Description Tipo Status
az iot ops asset create

Crie um ativo.

 Extensão Visualizar
az iot ops asset data-point

Gerencie pontos de dados em um ativo.

 Extensão Visualizar
az iot ops asset data-point add

Adicione um ponto de dados a um ativo.

 Extensão Visualizar
az iot ops asset data-point export

Exporte pontos de dados em um ativo.

 Extensão Visualizar
az iot ops asset data-point import

Importe pontos de dados em um ativo.

 Extensão Visualizar
az iot ops asset data-point list

Listar pontos de dados em um ativo.

 Extensão Visualizar
az iot ops asset data-point remove

Remova um ponto de dados em um ativo.

 Extensão Visualizar
az iot ops asset delete

Exclua um ativo.

 Extensão Visualizar
az iot ops asset endpoint

Gerencie perfis de endpoint de ativos.

 Extensão Visualizar
az iot ops asset endpoint certificate

Gerencie certificados de propriedade em um endpoint de ativo.

 Extensão Visualizar
az iot ops asset endpoint certificate add

Adicione um certificado de propriedade a um ponto de extremidade de ativo.

 Extensão Visualizar
az iot ops asset endpoint certificate list

Listar certificados de propriedade em um ponto de extremidade de ativo.

 Extensão Visualizar
az iot ops asset endpoint certificate remove

Remova um certificado de propriedade em um endpoint de ativo.

 Extensão Visualizar
az iot ops asset endpoint create

Crie um endpoint de ativo.

 Extensão Visualizar
az iot ops asset endpoint delete

Exclua um endpoint de ativo.

 Extensão Visualizar
az iot ops asset endpoint query

Consulte o Resource Graph para pontos de extremidade de ativos.

 Extensão Visualizar
az iot ops asset endpoint show

Mostrar um ponto de extremidade do ativo.

 Extensão Visualizar
az iot ops asset endpoint update

Atualize um endpoint de ativo.

 Extensão Visualizar
az iot ops asset event

Gerencie eventos em um ativo.

 Extensão Visualizar
az iot ops asset event add

Adicione um evento a um ativo.

 Extensão Visualizar
az iot ops asset event export

Exportar eventos em um ativo.

 Extensão Visualizar
az iot ops asset event import

Importe eventos em um ativo.

 Extensão Visualizar
az iot ops asset event list

Listar eventos em um ativo.

 Extensão Visualizar
az iot ops asset event remove

Remova um evento em um ativo.

 Extensão Visualizar
az iot ops asset query

Consulte o Resource Graph para ativos.

 Extensão Visualizar
az iot ops asset show

Mostrar um ativo.

 Extensão Visualizar
az iot ops asset update

Atualize um ativo.

 Extensão Visualizar

az iot ops asset create

Versão Prévia

O grupo de comandos 'iot ops' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Crie um ativo.

O local personalizado ou o nome do cluster devem ser fornecidos. Esse comando verificará a existência do local personalizado e do cluster associados e garantirá que ambos estejam configurados corretamente com a extensão microsoft.deviceregistry.assets.

Pelo menos um ponto de dados ou evento deve ser definido durante a criação do ativo. Para obter exemplos de formatos de arquivo, consulte aka.ms/aziotops-assets.

az iot ops asset create --endpoint
                        --name
                        --resource-group
                        [--asset-type]
                        [--attr]
                        [--cg]
                        [--cl]
                        [--clg]
                        [--cls]
                        [--cluster]
                        [--cluster-subscription]
                        [--data]
                        [--data-file]
                        [--data-publish-int]
                        [--data-queue-size]
                        [--data-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--ef]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--event]
                        [--hardware-revision]
                        [--location]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]

Exemplos

Crie um ativo usando o local personalizado fornecido.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --data data_source={data_source}

Crie um ativo usando o local personalizado e o grupo de recursos fornecidos para o local personalizado. O grupo de recursos deve ser incluído se houver vários locais personalizados com o mesmo nome em uma assinatura.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --custom-location-resource-group {custom_location_resource_group} --endpoint {endpoint} --data data_source={data_source}

Crie um ativo usando o nome de cluster fornecido. O grupo de recursos deve ser incluído se houver vários clusters com o mesmo nome em uma assinatura.

az iot ops asset create --name {asset_name} -g {resource_group} --cluster {cluster} --cluster-resource-group {cluster_resource_group} --endpoint {endpoint} --event event_notifier={event_notifier}

Crie um ativo usando o nome do cluster fornecido e o local personalizado.

az iot ops asset create --name {asset_name} -g {resource_group} --cluster {cluster} --custom-location {custom_location} --endpoint {endpoint} --event event_notifier={event_notifier}

Crie um ativo com padrões de evento e ponto de dados personalizados.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --data-publish-int {data_point_publishing_interval} --data-queue-size {data_point_queue_size} --data-sample-int {data_point_sampling_interval} --event-publish-int {event_publishing_interval} --event-queue-size {event_queue_size} --event-sample-int {event_sampling_interval} --event event_notifier={event_notifier}

Crie um ativo com atributos personalizados adicionais.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --custom-attribute {attribute_key}={attribute_value} --custom-attribute {attribute_key}={attribute_value}

Crie um ativo com tipo de ativo personalizado, descrição, URI de documentação, ID de ativo externo, revisão de hardware, código do produto e revisão de software.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --asset-type {asset_type} --description {description} --documentation-uri {documentation_uri} --external-asset-id {external_asset_id} --hardware-revision {hardware_revision} --product-code {product_code} --software-revision {software_revision} --data data_source={data_source}

Crie um ativo com dois eventos, fabricante, uri do fabricante, modelo, número de série.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --event capability_id={capability_id} event_notifier={event_notifier} name={name} observability_mode={observability_mode} sampling_interval={sampling_interval} queue_size={queue_size} --event event_notifier={event_notifier} --manufacturer {manufacturer} --manufacturer-uri {manufacturer_uri} --model {model} --serial-number {serial_number}

Crie um ativo desativado com dois pontos de dados.

az iot ops asset create --name {asset_name} -g {resource_group} --custom-location {custom_location} --endpoint {endpoint} --disable --data capability_id={capability_id} data_source={data_source} name={name} observability_mode={observability_mode} sampling_interval={sampling_interval} queue_size={queue_size} --data data_source={data_source}

Crie um ativo usando um arquivo contendo pontos de dados e outro arquivo contendo eventos.

az iot ops asset create --name MyAsset -g MyRg --custom-location MyLocation --endpoint exampleEndpoint --data-file /path/to/myasset_datapoints.json --event-file /path/to/myasset_events.csv

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

az iot ops asset create --name MyAsset -g MyRg --custom-location MyLocation --endpoint exampleEndpoint --data capability_id=myTagId data_source=NodeID1 name=myTagName1 observability_mode=counter sampling_interval=10 queue_size=2 --data data_source=NodeID2 --data-publish-int 1000 --data-queue-size 1 --data-sample-int 30 --asset-type customAsset --description 'Description for a test asset.' --documentation-uri www.help.com --external-asset-id 000-000-0000 --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

--endpoint

Nome do ponto de extremidade do ativo.

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

--asset-type --at

Tipo de ativo.

--attr --custom-attribute

Pares chave=valor separados por espaço correspondentes a atributos personalizados adicionais para o ativo.

--cg --cluster-resource-group

Grupo de recursos para cluster.

--cl --custom-location

Local personalizado usado para associar o ativo ao cluster.

--clg --custom-location-resource-group

Grupo de recursos para local personalizado.

--cls --custom-location-subscription

ID de assinatura para local personalizado. Se não for fornecido, a ID de assinatura do ativo será usada.

--cluster -c

Cluster ao qual associar o ativo.

--cluster-subscription --cs

ID da assinatura para cluster. Se não for fornecido, a ID de assinatura do ativo será usada.

--data

Pares chave=valor separados por espaço correspondentes às propriedades do ponto de dados a ser criado. Há suporte para os seguintes valores de chave: capability_id, data_source (obrigatório), name, observability_mode (nenhum, medidor, contador, histograma ou log), sampling_interval (int), queue_size (int). --data pode ser usado 1 ou mais vezes. Examine os exemplos de ajuda para o uso completo do parâmetro.

--data-file --df

Caminho do arquivo para o arquivo que contém os pontos de dados. Os seguintes tipos de arquivo são suportados: csv, json, portal-csv, yaml.

--data-publish-int --dpi

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

Valor padrão: 1000
--data-queue-size --dqs

Tamanho da fila padrão para pontos de dados.

Valor padrão: 1
--data-sample-int --dsi

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

Valor padrão: 500
--description -d

Descrição.

--disable

Desative um ativo.

Valores aceitos: false, true
Valor padrão: False
--display-name --dn

Nome de exibição.

--documentation-uri --du

URI da 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: csv, json, portal-csv, yaml.

--epi --event-publish-int

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

Valor padrão: 1000
--eqs --event-queue-size

Tamanho da fila padrão para eventos.

Valor padrão: 1
--esi --event-sample-int

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

Valor padrão: 500
--event

Pares chave=valor separados por espaço correspondentes às propriedades do evento a ser criado. Há suporte para os seguintes valores de chave: capability_id, event_notifier (obrigatório), name, 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.

--hardware-revision --hr

Revisão de hardware.

--location -l

Local. 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. Recipiente de propriedades em pares de valores-chave com o seguinte formato: a=b c=d.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot ops asset delete

Versão Prévia

O grupo de comandos 'iot ops' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exclua um ativo.

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

Exemplos

Exclua um ativo.

az iot ops asset delete --name {asset_name} -g {resource_group}

Parâmetros Exigidos

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot ops asset query

Versão Prévia

O grupo de comandos 'iot ops' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Consulte o Resource Graph para ativos.

az iot ops asset query [--asset-type]
                       [--cl]
                       [--description]
                       [--disabled {false, true}]
                       [--display-name]
                       [--documentation-uri]
                       [--eai]
                       [--endpoint]
                       [--hardware-revision]
                       [--location]
                       [--manufacturer]
                       [--manufacturer-uri]
                       [--model]
                       [--pc]
                       [--resource-group]
                       [--serial-number]
                       [--software-revision]

Exemplos

Consultar ativos desativados em um determinado grupo de recursos.

az iot ops asset query -g {resource_group} --disabled

Consulte ativos que tenham o modelo, o fabricante e o número de série fornecidos.

az iot ops asset query --model {model} --manufacturer {manufacturer} --serial-number {serial_number}

Parâmetros Opcionais

--asset-type --at

Tipo de ativo.

--cl --custom-location

Local personalizado usado para associar o ativo ao cluster.

--description -d

Descrição.

--disabled

Estado do ativo.

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

Nome de exibição.

--documentation-uri --du

URI da documentação.

--eai --external-asset-id

ID do ativo externo.

--endpoint

Nome do ponto de extremidade do ativo.

--hardware-revision --hr

Revisão de hardware.

--location -l

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

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot ops asset show

Versão Prévia

O grupo de comandos 'iot ops' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Mostrar um ativo.

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

Exemplos

Mostre os detalhes de um ativo.

az iot ops asset show --name {asset_name} -g {resource_group}

Parâmetros Exigidos

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot ops asset update

Versão Prévia

O grupo de comandos 'iot ops' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Atualize um ativo.

Para atualizar pontos de dados e eventos, use os grupos az iot ops asset data-point de comandos e az iot ops asset events respectivamente.

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

Exemplos

Atualize o ponto de dados de um ativo e os padrões de evento.

az iot ops asset update --name {asset_name} -g {resource_group} --data-publish-int {data_point_publishing_interval} --data-queue-size {data_point_queue_size} --data-sample-int {data_point_sampling_interval} --event-publish-int {event_publishing_interval} --event-queue-size {event_queue_size} --event-sample-int {event_sampling_interval}

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

az iot ops asset update --name {asset_name} -g {resource_group} --asset-type {asset_type} --description {description} --documentation-uri {documentation_uri} --external-asset-id {external_asset_id} --hardware-revision {hardware_revision} --product-code {product_code} --software-revision {software_revision}

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 {asset_name} -g {resource_group} --manufacturer {manufacturer} --manufacturer-uri {manufacturer_uri} --model {model} --serial-number {serial_number} --custom-attribute {attribute_key}={attribute_value}

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

az iot ops asset update --name {asset_name} -g {resource_group} --disable --custom-attribute work_site=""

Parâmetros Exigidos

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

--asset-type --at

Tipo de ativo.

--attr --custom-attribute

Pares chave=valor separados por espaço correspondentes a atributos personalizados adicionais para o ativo. Para remover um atributo personalizado, defina o valor do atributo como "".

--data-publish-int --dpi

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

--data-queue-size --dqs

Tamanho da fila padrão para pontos de dados.

--data-sample-int --dsi

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

--description -d

Descrição.

--disable

Desative um ativo.

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

Nome de exibição.

--documentation-uri --du

URI da documentação.

--eai --external-asset-id

ID do ativo externo.

--epi --event-publish-int

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

--eqs --event-queue-size

Tamanho da 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. Recipiente de propriedades em pares de valores-chave com o seguinte formato: a=b c=d.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.