az iot ops
Observação
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 suporte: https://aka.ms/CLI_refstatus
Gerenciar operações de IoT do Azure.
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 Broker MQTT de nível industrial, adicionar computação de borda e configurar fluxo de dados bidirecional com uma variedade de serviços na nuvem.
Por padrão, os comandos da CLI do IoT Operations 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
| Nome | Description | Tipo | Status |
|---|---|---|---|
| az iot ops asset |
Gerenciar ativos. |
Extensão | Visualizar |
| az iot ops asset create |
Crie um ativo. |
Extensão | Visualizar |
| az iot ops asset data-point |
Gerenciar pontos de dados em um ativo. |
Extensão | Visualizar |
| az iot ops asset data-point add |
Adicionar um ponto de dados a um ativo. |
Extensão | Visualizar |
| az iot ops asset data-point export |
Exportar pontos de dados em um ativo. |
Extensão | Visualizar |
| az iot ops asset data-point import |
Importar 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 |
Remover um ponto de dados em um ativo. |
Extensão | Visualizar |
| az iot ops asset delete |
Excluir um ativo. |
Extensão | Visualizar |
| az iot ops asset endpoint |
Gerenciar perfis de endpoint de ativos. |
Extensão | Visualizar |
| az iot ops asset endpoint certificate |
Gerenciar certificados de propriedade em um ponto de extremidade 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 ponto de extremidade de ativo. |
Extensão | Visualizar |
| az iot ops asset endpoint create |
Crie um ponto de extremidade de ativo. |
Extensão | Visualizar |
| az iot ops asset endpoint delete |
Excluir um ponto de extremidade de ativo. |
Extensão | Visualizar |
| az iot ops asset endpoint query |
Consulte o gráfico de recursos para pontos de extremidade de ativos. |
Extensão | Visualizar |
| az iot ops asset endpoint show |
Mostrar um ponto de extremidade de ativo. |
Extensão | Visualizar |
| az iot ops asset endpoint update |
Atualizar um ponto de extremidade de ativo. |
Extensão | Visualizar |
| az iot ops asset event |
Gerenciar eventos em um ativo. |
Extensão | Visualizar |
| az iot ops asset event add |
Adicionar 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 |
Importar 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 |
Remover um evento em um ativo. |
Extensão | Visualizar |
| az iot ops asset query |
Consulte o gráfico de recursos para ativos. |
Extensão | Visualizar |
| az iot ops asset show |
Mostrar um ativo. |
Extensão | Visualizar |
| az iot ops asset update |
Atualizar um ativo. |
Extensão | 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 | Visualizar |
| az iot ops delete |
Exclua as Operações de IoT do cluster. |
Extensão | Visualizar |
| az iot ops init |
Inicialize, configure e implante operações de IoT no cluster habilitado para arco de destino. |
Extensão | Visualizar |
| az iot ops mq |
Ferramentas específicas do MQ. |
Extensão | 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 | Visualizar |
| az iot ops mq stats |
Mostrar estatísticas de execução do dmqtt. |
Extensão | Visualizar |
| az iot ops support |
As operações de IoT oferecem suporte ao espaço de comando. |
Extensão | 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 | 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 | Visualizar |
az iot ops check
O grupo de comando 'iot ops' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: 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 para humanos 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 resumida.
az iot ops checkAvalia 'mq' como exemplo anterior, no entanto, a saída é otimizada para CI.
az iot ops check --as-objectVerifica a integridade e a configuração do 'processador de dados' com saída detalhada.
az iot ops check --svc dataprocessor --detail-level 1O mesmo que o exemplo anterior, exceto restringindo os resultados ao recurso 'pipeline'.
az iot ops check --svc dataprocessor --detail-level 1 --resources pipelineUse 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 pipelineUse o nome do recurso para restringir os resultados a nomes de recursos que começam com 'nome-do-pipeline'.
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
Conteúdo de verificação de saída e validações em uma estrutura de dados amigável para CI.
Nome de contexto Kubeconfig a ser usado para comunicação de cluster k8s. Se nenhum contexto for fornecido, current_context será usado.
Controla o nível de detalhes exibido na saída de verificação. Escolha 0 para uma exibição de resumo (saída mínima), 1 para uma exibição detalhada (informações mais abrangentes) ou 2 para uma exibição detalhada (todas as informações disponíveis).
A implantação do serviço IoT Operations que será avaliada.
Execute verificações pós-implantação.
Execute verificações de pré-requisitos para determinar se os requisitos mínimos de uma implantação de serviço são atendidos.
Execute apenas verificações para o nome do recurso específico. O nome diferencia maiúsculas de minúsculas. Os padrões Glob '' e '?' são suportados. Nota: Somente caracteres alfanuméricos, hífens, '?' e '' são permitidos.
Execute apenas verificações em tipos de recursos específicos. Use valores separados por espaço.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
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 o detalhamento do log. Use --debug para logs de depuração completos.
az iot ops delete
O grupo de comando 'iot ops' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus
Exclua as Operações de IoT do cluster.
A operação usa o Gráfico de Recursos do Azure para determinar recursos correlacionados. O Gráfico de Recursos ser eventualmente consistente não garante um estado sincronizado no momento da execução.
az iot ops delete --cluster
--resource-group
[--force {false, true}]
[--no-progress {false, true}]
[--yes {false, true}]Exemplos
Entrada mínima para exclusão completa.
az iot ops delete --cluster mycluster -g myresourcegroupIgnore o prompt de confirmação e continue com o processo de exclusão. Útil para cenários de IC.
az iot ops delete --cluster mycluster -g myresourcegroup -yForçar a exclusão independentemente dos avisos. Pode levar a erros.
az iot ops delete --cluster mycluster -g myresourcegroup --forceParâmetros Exigidos
Nome do cluster de destino para exclusão de Operações IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Forçar a execução da operação.
Desativar a representação visual do trabalho.
Confirme [y]es sem um prompt. Útil para cenários de CI e automação.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
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 o detalhamento do log. Use --debug para logs de depuração completos.
az iot ops init
O grupo de comando 'iot ops' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus
Inicialize, configure e implante operações de 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
Nota: O processador de dados não é implantado por padrão. Use --include-dp para adicioná-lo.
az iot ops init --cluster
--resource-group
[--ca-dir]
[--ca-file]
[--ca-key-file]
[--ca-valid-days]
[--cluster-namespace]
[--context]
[--csi-config]
[--csi-ver]
[--custom-location]
[--disable-rotation {false, true}]
[--disable-rsync-rules {false, true}]
[--dp-instance]
[--ensure-latest {false, true}]
[--include-dp {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 Cofre de Chaves, a implantação do driver CSI, a configuração do TLS e a implantação de Operações de IoT.
az iot ops init --cluster mycluster -g myresourcegroup --kv-id /subscriptions/2cb3a427-1abc-48d0-9d03-dd240819742a/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mykeyvaultMesma 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. A inclusão do 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-plcPara ignorar a implantação e se concentrar apenas no driver CSI do Key Vault e nos fluxos de trabalho de configuração TLS, basta passar em '--no-deploy'. Isso pode ser útil quando 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-deployPara implantar apenas Operações de IoT em um cluster que já foi preparado, basta omitir '--kv-id' e incluir '--no-tls'.
az iot ops init --cluster mycluster -g myresourcegroup --no-tlsUse '--no-block' para fazer outro trabalho enquanto a implantação está em andamento vs aguardar 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-blockPara evitar chamar o MS Graph, como para cenários de CI em que as permissões de entidade de serviço logadas em az cli são limitadas ou uma entidade de serviço existente deve ser reutilizada, forneça todos os itens '--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 da Chave.
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_SECRETPara personalizar a configuração do driver CSI do Cofre da Chave, --csi-config pode ser usado. Por exemplo, definindo limites de recursos na dependência do contêiner telegraf.
az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --csi-config telegraf.resources.limits.memory=500Mi telegraf.resources.limits.cpu=100mParâmetros Exigidos
Nome do cluster de destino para implantação de Operações IoT.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
O diretório local no qual 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.
O caminho para o arquivo CA desejado no formato PEM.
O caminho para o arquivo de chave privada da autoridade de certificação no formato PEM. ! Necessário! quando --ca-file é fornecido.
Opção para controlar a duração em dias da AC x509 gerada pela inicialização. Aplicável se --ca-file e --ca-key-file não forem fornecidos.
O namespace de cluster IoT Operations infra será implantado em. Precisa estar em minúsculas.
Nome de contexto Kubeconfig a ser usado para comunicação de cluster k8s. Se nenhum contexto for fornecido, current_context será usado.
Configuração personalizada da extensão do driver CSI. O formato é separado por espaço pares key=value. --csi-config pode ser usado uma ou mais vezes.
Versão da extensão do driver CSI.
O nome do local personalizado correspondente à implantação de Operações IoT. O padrão está no formato '{cluster_name}-ops-init-cl'.
Sinalizador para desativar a rotação secreta.
As regras de sincronização de recursos não serão incluídas na implantação de Operações de IoT.
Nome da instância do Processador de Dados. O padrão está no formato '{cluster_name}-ops-init-processor'.
Verifique se a CLI de IoT Ops mais recente está sendo usada, gerando um erro se uma atualização estiver disponível.
Inclua o Processador de Dados na implantação de Operações de IoT. Padrão: falso.
A distro Kubernetes a ser usada para a configuração do Akri. A distro selecionada implica o caminho de soquete de tempo de execução do contêiner padrão quando nenhum valor --runtime-socket é fornecido.
ID do recurso ARM do Cofre da Chave. O fornecimento dessa 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 de IoT.
O nome secreto do Cofre de Chaves 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.
O local do ARM que será usado para garantia RPSaaS provisionada. Se não for fornecido, o local do cluster conectado será usado.
O nome mq authN. O padrão é 'authn'.
Partições de back-end MQ.
Fator de redundância de back-end MQ.
Trabalhadores de back-end MQ.
O nome do corretor mq. O padrão é 'broker'.
Réplicas de front-end MQ.
O nome do servidor de front-end mq. O padrão é 'mq-dmqtt-frontend'.
Trabalhadores de frontend MQ.
Quando habilitada, a implantação do 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.
O nome da instância mq. O padrão está no formato 'init-{hash}-mq-instance'.
O nome do ouvinte mq. O padrão é 'ouvinte'.
Perfil de memória MQ.
Modo de operação MQ.
Tipo de serviço MQ.
Retorne imediatamente após o início da implantação das Operações de IoT.
O fluxo de trabalho de implantação de Operações de IoT será ignorado.
Desativar a representação visual do trabalho.
O fluxo de trabalho de configuração do TLS será ignorado.
Configura um ponto de extremidade de 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'.
Intervalo de sondagem de rotação.
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.
Sinalizador, quando definido, produzirá o modelo destinado à implantação.
Sinalizador quando definido, configurará o instalador do broker OPC-UA para girar um servidor PLC.
ID do aplicativo da entidade de serviço. Se fornecido será usado para a configuração do driver CSI. Caso contrário, um registro de aplicativo será criado. Obrigatório se a entidade de segurança conectada não tiver permissões para consultar o gráfico.
Id do objeto da entidade de serviço (sp). Se fornecido será usado para a configuração do driver CSI. Caso contrário, o Id do objeto será consultado a partir do ID do aplicativo - criando o sp se um 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 de objeto adequado. Como alternativa, usando o Portal, você pode navegar até Aplicativos Corporativos em seu locatário do Entra Id.
O segredo correspondente à 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.
Opção para controlar a duração em dias do segredo principal de serviço gerado pela inicialização. Aplicável se --sp-secret não for fornecido.
Nome de destino para o orquestrador de operações. O padrão está no formato '{cluster_name}-ops-init-target'.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
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 o detalhamento do log. Use --debug para logs de depuração completos.
az iot ops verify-host
O grupo de comando 'iot ops' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: 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
Desativar a representação visual do trabalho.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
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 o detalhamento do log. Use --debug para logs de depuração completos.
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de