az iot ops

Pré-visualizar
Referência

Nota

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

Este grupo de comandos está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Gerencie as operações do Azure IoT.

O Azure IoT Operations é um conjunto de serviços Kubernetes primários altamente alinhados, mas fracamente acoplados, que permitem agregar dados de ativos locais em um MQTT Broker de nível industrial, adicionar computação de borda e configurar o fluxo de dados bidirecional com uma variedade de serviços na nuvem.

Por padrão, os comandos da CLI de Operações IoT verificarão periodicamente se uma nova versão de extensão está disponível. Esse comportamento pode ser desabilitado com az config set iotops.check_latest=falseo .

Comandos

Name	Description	Tipo	Estado
az iot ops asset	Gerencie ativos.	Extensão	Pré-visualizar
az iot ops asset create	Crie um elemento.	Extensão	Pré-visualizar
az iot ops asset data-point	Gerencie pontos de dados em um ativo.	Extensão	Pré-visualizar
az iot ops asset data-point add	Adicione um ponto de dados a um ativo.	Extensão	Pré-visualizar
az iot ops asset data-point export	Exporte pontos de dados em um ativo.	Extensão	Pré-visualizar
az iot ops asset data-point import	Importe pontos de dados em um ativo.	Extensão	Pré-visualizar
az iot ops asset data-point list	Listar pontos de dados em um ativo.	Extensão	Pré-visualizar
az iot ops asset data-point remove	Remova um ponto de dados em um ativo.	Extensão	Pré-visualizar
az iot ops asset delete	Excluir um ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint	Gerencie perfis de ponto de extremidade de ativos.	Extensão	Pré-visualizar
az iot ops asset endpoint certificate	Gerencie certificados de propriedade em um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint certificate add	Adicione um certificado de propriedade a um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint certificate list	Listar certificados de propriedade em um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint certificate remove	Remova um certificado de propriedade em um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint create	Crie um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint delete	Exclua um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint query	Consulte o gráfico de recursos para pontos de extremidade de ativos.	Extensão	Pré-visualizar
az iot ops asset endpoint show	Mostrar um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset endpoint update	Atualize um ponto de extremidade de ativo.	Extensão	Pré-visualizar
az iot ops asset event	Gerencie eventos em um ativo.	Extensão	Pré-visualizar
az iot ops asset event add	Adicione um evento a um ativo.	Extensão	Pré-visualizar
az iot ops asset event export	Exportar eventos em um ativo.	Extensão	Pré-visualizar
az iot ops asset event import	Importar eventos em um ativo.	Extensão	Pré-visualizar
az iot ops asset event list	Listar eventos em um ativo.	Extensão	Pré-visualizar
az iot ops asset event remove	Remova um evento em um ativo.	Extensão	Pré-visualizar
az iot ops asset query	Consulte o gráfico de recursos para ativos.	Extensão	Pré-visualizar
az iot ops asset show	Mostrar um ativo.	Extensão	Pré-visualizar
az iot ops asset update	Atualize um ativo.	Extensão	Pré-visualizar
az iot ops check	Avalie a integridade do tempo de execução do lado do cluster dos serviços de Operações IoT implantados.	Extensão	Pré-visualizar
az iot ops init	Inicialize, configure e implante Operações IoT no cluster habilitado para arco de destino.	Extensão	Pré-visualizar
az iot ops mq	Ferramentas específicas MQ.	Extensão	Pré-visualizar
az iot ops mq get-password-hash	Gera um hash PBKDF2 da senha aplicando PBKDF2-HMAC-SHA512. Um sal de 128 bits é usado a partir de os.urandom.	Extensão	Pré-visualizar
az iot ops mq stats	Mostrar estatísticas de execução dmqtt.	Extensão	Pré-visualizar
az iot ops support	O espaço de comando de suporte às Operações IoT.	Extensão	Pré-visualizar
az iot ops support create-bundle	Cria um arquivo zip de pacote de suporte padrão para uso em solução de problemas e diagnósticos.	Extensão	Pré-visualizar
az iot ops verify-host	Executa um conjunto de verificações de host de cluster para compatibilidade de implantação de Operações IoT.	Extensão	Pré-visualizar

az iot ops check

Pré-visualizar

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

Avalie a integridade do tempo de execução do lado do cluster dos serviços de Operações IoT implantados.

O comando, por padrão, mostra uma exibição de resumo amigável do serviço selecionado. Mais detalhes podem ser solicitados via --detail-level.

{APIs de serviço suportadas}

akri.sh/[v0]
dataprocessor.iotoperations.azure.com/[v1]
deviceregistry.microsoft.com/[v1beta1]
layerednetworkmgmt.iotoperations.azure.com/[v1beta1]
mq.iotoperations.azure.com/[v1beta1]
opcuabroker.iotoperations.azure.com/[v1beta1].

az iot ops check [--as-object {false, true}]
                 [--context]
                 [--detail-level {0, 1, 2}]
                 [--ops-service {akri, dataprocessor, deviceregistry, lnm, mq, opcua}]
                 [--post {false, true}]
                 [--pre {false, true}]
                 [--resource-name]
                 [--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline}]

Exemplos

Uso básico. Verifica a integridade 'mq' com saída de resumo.

az iot ops check

Avalia 'mq' como exemplo anterior, no entanto, a saída é otimizada para CI.

az iot ops check --as-object

Verifica a integridade e a configuração do 'processador de dados' com saída detalhada.

az iot ops check --svc dataprocessor --detail-level 1

O mesmo que o exemplo anterior, exceto restringindo os resultados ao recurso 'pipeline'.

az iot ops check --svc dataprocessor --detail-level 1 --resources pipeline

Use o nome do recurso para restringir os resultados ao recurso 'pipeline' exatamente correspondente ao nome 'pipeline'.

az iot ops check --svc dataprocessor  --resources pipeline --resource-name pipeline

Use o nome do recurso para restringir os resultados a nomes de recursos que comecem com 'pipeline-name'.

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline-name*

Use o padrão glob '?' para restringir os resultados a nomes de recursos que contenham 'pipeline' e terminem com um único caractere.

az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline?

Parâmetros Opcionais

--as-object

Conteúdo de verificação de saída e validações em uma estrutura de dados amigável para CI.

valores aceites: false, true

--context

Nome de contexto Kubeconfig a ser usado para comunicação de cluster k8s. Se nenhum contexto for fornecido, current_context será usado.

--detail-level

Controla o nível de detalhe exibido na saída de verificação. Escolha 0 para uma vista de resumo (saída mínima), 1 para uma vista detalhada (informações mais abrangentes) ou 2 para uma vista detalhada (todas as informações disponíveis).

valores aceites: 0, 1, 2

valor predefinido: 0

--ops-service --svc

A implantação do serviço IoT Operations que será avaliada.

valores aceites: akri, dataprocessor, deviceregistry, lnm, mq, opcua

valor predefinido: mq

--post

Execute verificações pós-implantação.

valores aceites: false, true

--pre

Execute verificações de pré-requisitos para determinar se os requisitos mínimos de uma implantação de serviço são atendidos.

valores aceites: false, true

--resource-name --rn

Execute apenas verificações para o nome do recurso específico. O nome não diferencia maiúsculas de minúsculas. Os padrões Glob '' e '?' são suportados. Nota: Apenas são permitidos carateres alfanuméricos, hífenes, «?' e «».

--resources

Execute verificações apenas em tipos de recursos específicos. Use valores separados por espaço.

valores aceites: asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline

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 iot ops init

Pré-visualizar

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

Inicialize, configure e implante Operações IoT no cluster habilitado para arco de destino.

Para obter recursos adicionais, incluindo como habilitar um cluster em arco, consulte https://learn.microsoft.com/en-us/azure/iot-operations/deploy-iot-ops/howto-prepare-cluster.

az iot ops init --cluster
                --resource-group
                [--ca-dir]
                [--ca-file]
                [--ca-key-file]
                [--ca-valid-days]
                [--cluster-namespace]
                [--context]
                [--csi-driver-ver]
                [--custom-location]
                [--disable-rotation {false, true}]
                [--disable-rsync-rules {false, true}]
                [--dp-instance]
                [--ensure-latest {false, true}]
                [--kubernetes-distro {k3s, k8s, microk8s}]
                [--kv-id]
                [--kv-spc-secret-name]
                [--location]
                [--mq-authn]
                [--mq-backend-part]
                [--mq-backend-rf]
                [--mq-backend-workers]
                [--mq-broker]
                [--mq-frontend-replicas]
                [--mq-frontend-server]
                [--mq-frontend-workers]
                [--mq-insecure {false, true}]
                [--mq-instance]
                [--mq-listener]
                [--mq-mem-profile {high, low, medium, tiny}]
                [--mq-mode {auto, distributed}]
                [--mq-service-type {clusterIp, loadBalancer, nodePort}]
                [--no-block {false, true}]
                [--no-deploy {false, true}]
                [--no-progress {false, true}]
                [--no-tls {false, true}]
                [--opcua-discovery-url]
                [--rotation-int]
                [--runtime-socket]
                [--show-template {false, true}]
                [--simulate-plc {false, true}]
                [--sp-app-id]
                [--sp-object-id]
                [--sp-secret]
                [--sp-secret-valid-days]
                [--target]

Exemplos

Entrada mínima para configuração completa. Isso inclui a configuração do Key Vault, a implantação do driver CSI, a configuração TLS e a implantação do IoT Operations.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id /subscriptions/2cb3a427-1abc-48d0-9d03-dd240819742a/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mykeyvault

Mesma configuração do exemplo anterior, exceto com o uso de um ID de aplicativo existente e um sinalizador para incluir um servidor PLC simulado como parte da implantação. Incluir o ID do aplicativo impedirá que o 'init' crie um registro de aplicativo.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --simulate-plc

Para ignorar a implantação e se concentrar apenas nos fluxos de trabalho de configuração CSI e configuração do Key Vault, CSI, passe simplesmente em '--no-deploy'. Isso pode ser útil ao desejar implantar a partir de uma ferramenta diferente, como o Portal.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-deploy

Para implantar operações de IoT apenas em um cluster que já foi preparado, basta omitir '--kv-id' e incluir '--no-tls'.

az iot ops init --cluster mycluster -g myresourcegroup --no-tls

Use '--no-block' para fazer outro trabalho enquanto a implantação está em andamento vs aguardando a conclusão da implantação antes de iniciar o outro trabalho.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-block

Para evitar chamar o MS Graph, como em cenários de CI em que as permissões da entidade de serviço az cli conectadas são limitadas ou uma entidade de serviço existente deve ser reutilizada, forneça todas as opções '--sp-app-id', '--sp-object-id' e '--sp-secret'. Esses valores devem refletir a entidade de serviço desejada que será usada para a configuração do driver CSI do Cofre de Chaves.

az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --sp-object-id 224a7a3f-c63d-4923-8950-c4a85f0d2f29 --sp-secret $SP_SECRET

Parâmetros Obrigatórios

--cluster

Nome do cluster de destino para implantação de Operações IoT.

--resource-group -g

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

Parâmetros Opcionais

--ca-dir

O diretório local em que a autoridade de certificação de teste gerada e a chave privada serão colocadas. Se nenhum diretório for fornecido, nenhum arquivo será gravado no disco. Aplicável quando nenhum --ca-file e --ca-key-file são fornecidos.

--ca-file

O caminho para o arquivo CA desejado no formato PEM.

--ca-key-file

O caminho para o arquivo de chave privada da autoridade de certificação no formato PEM. ! Necessário! quando --ca-file é fornecido.

--ca-valid-days

Opção para controlar a duração em dias da AC x509 gerada pelo init. Aplicável se --ca-file e --ca-key-file não forem fornecidos.

valor predefinido: 365

--cluster-namespace

O namespace de cluster IoT Operations infra será implantado. Deve ser minúscula.

valor predefinido: azure-iot-operations

--context

Nome de contexto Kubeconfig a ser usado para comunicação de cluster k8s. Se nenhum contexto for fornecido, current_context será usado.

--csi-driver-ver

Versão do driver CSI.

valor predefinido: 1.5.2

--custom-location

O nome do local personalizado correspondente à implantação das Operações IoT. O padrão está no formato '{cluster_name}-ops-init-cl'.

--disable-rotation

Sinalizador para desativar a rotação secreta.

valores aceites: false, true

--disable-rsync-rules

As regras de sincronização de recursos não serão incluídas na implantação.

valores aceites: false, true

--dp-instance

Nome da instância para o processador de dados. O padrão está no formato '{cluster_name}-ops-init-processor'.

--ensure-latest

Verifique se a CLI de IoT Ops mais recente está instalada, gerando um erro se uma atualização estiver disponível.

valores aceites: false, true

--kubernetes-distro

A distro Kubernetes a ser usada para a configuração do Akri. A distribuição selecionada implica o caminho de soquete de tempo de execução do contêiner padrão quando nenhum valor --runtime-socket é fornecido.

valores aceites: k3s, k8s, microk8s

valor predefinido: k8s

--kv-id

ID do recurso ARM do Cofre da Chave. Fornecer essa ID de recurso permitirá que o cliente configure todos os recursos necessários e a configuração do lado do cluster para habilitar o driver CSI do Cofre da Chave para Operações IoT.

--kv-spc-secret-name

O nome secreto do Cofre da Chave a ser usado como o segredo padrão do SPC. Se o segredo não existir, ele será criado com um valor de espaço reservado criptograficamente seguro.

valor predefinido: azure-iot-operations

--location

O local do ARM que será usado para garantias RPSaaS provisionadas. Se não for fornecido, o local do cluster conectado será usado.

--mq-authn

O nome mq authN. O padrão é 'authn'.

--mq-backend-part

Partições de back-end MQ.

valor predefinido: 2

--mq-backend-rf

Fator de redundância de back-end MQ.

valor predefinido: 2

--mq-backend-workers

Trabalhadores de back-end MQ.

valor predefinido: 2

--mq-broker

O nome do corretor mq. O padrão é 'broker'.

--mq-frontend-replicas

Réplicas de frontend MQ.

valor predefinido: 2

--mq-frontend-server

O nome do servidor frontend mq. O padrão é 'mq-dmqtt-frontend'.

--mq-frontend-workers

Trabalhadores frontend MQ.

valor predefinido: 2

--mq-insecure

Quando habilitada, a implantação mq incluirá um ouvinte vinculado à porta 1883 sem authN ou authZ. A configuração encryptInternalTraffic do broker será definida como false. Apenas para cargas de trabalho que não sejam de produção.

valores aceites: false, true

--mq-instance

O nome da instância mq. O padrão está no formato 'init-{hash}-mq-instance'.

--mq-listener

O nome do ouvinte mq. O padrão é 'ouvinte'.

--mq-mem-profile

Perfil de memória MQ.

valores aceites: high, low, medium, tiny

valor predefinido: medium

--mq-mode

Modo de operação MQ.

valores aceites: auto, distributed

valor predefinido: distributed

--mq-service-type

Tipo de serviço MQ.

valores aceites: clusterIp, loadBalancer, nodePort

valor predefinido: clusterIp

--no-block

Retorne imediatamente após o início da implantação das Operações IoT.

valores aceites: false, true

--no-deploy

O fluxo de trabalho de implantação de Operações IoT será ignorado.

valores aceites: false, true

--no-progress

Desative a barra de progresso init.

valores aceites: false, true

--no-tls

O fluxo de trabalho de configuração TLS será ignorado.

valores aceites: false, true

--opcua-discovery-url

Configura um ponto de extremidade do servidor OPC-UA para manipuladores de descoberta Akri. Se não for fornecido e --simulate-plc estiver definido, esse valor se tornará 'opc.tcp://opcplc-000000. {cluster_namespace}:50000'.

--rotation-int

Intervalo de sondagem de rotação.

valor predefinido: 1h

--runtime-socket

O caminho do nó padrão do soquete de tempo de execução do contêiner. Se não for fornecido (padrão), o caminho do soquete será determinado por --kubernetes-distro.

--show-template

Sinalizador, quando definido, produzirá o modelo destinado à implantação.

valores aceites: false, true

--simulate-plc

Sinalizador quando definido, configurará o instalador do broker OPC-UA para girar um servidor PLC.

valores aceites: false, true

--sp-app-id

ID do aplicativo principal de serviço. Se fornecido será usado para a configuração do driver CSI. Caso contrário, será criado um registo de aplicação. Obrigatório se a entidade de segurança conectada não tiver permissões para consultar o gráfico.

--sp-object-id

Id do objeto da entidade de serviço (sp). Se fornecido será usado para a configuração do driver CSI. Caso contrário, o objeto Id será consultado a partir do ID do aplicativo - criando o sp se não existir. Obrigatório se a entidade de segurança conectada não tiver permissões para consultar o gráfico. Use az ad sp show --id <app Id> --query id -o tsv para produzir o Id do objeto adequado. Como alternativa, usando o Portal, você pode navegar até Aplicativos Empresariais em seu locatário do Entra Id.

--sp-secret

O segredo correspondente ao ID do aplicativo principal de serviço fornecido. Se fornecido será usado para a configuração do driver CSI. Caso contrário, um novo segredo será criado. Obrigatório se a entidade de segurança conectada não tiver permissões para consultar o gráfico.

--sp-secret-valid-days

Opção para controlar a duração em dias do segredo principal de serviço gerado pelo init. Aplicável se --sp-secret não for fornecido.

valor predefinido: 365

--target

Nome de destino para o orquestrador de operações. O padrão está no formato '{cluster_name}-ops-init-target'.

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 iot ops verify-host

Pré-visualizar

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

Executa um conjunto de verificações de host de cluster para compatibilidade de implantação de Operações IoT.

Destinado a ser executado diretamente em um host de cluster de destino. O comando pode solicitar a aplicação de um conjunto de ações privilegiadas, como a instalação de uma dependência. Nesse caso, a CLI deve ser executada com permissões elevadas. Por exemplo, sudo AZURE_EXTENSION_DIR=~/.azure/cliextensions az iot ops verify-host.

az iot ops verify-host [--no-progress {false, true}]

Parâmetros Opcionais

--no-progress

Desative a representação visual do trabalho.

valores aceites: false, true

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

Comandos

az iot ops check

Exemplos

Parâmetros Opcionais

az iot ops init

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az iot ops verify-host

Parâmetros Opcionais

Comentários

Recursos adicionais