az iot ops

Nota:

Esta referencia forma parte de la extensión azure-iot-ops para la CLI de Azure (versión 2.46.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot ops . Obtenga más información sobre las extensiones.

Este grupo de comandos está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Administración de operaciones de Azure IoT.

Azure IoT Operations es un conjunto de servicios de Kubernetes altamente alineados, pero acoplados de forma flexible que permiten agregar datos de recursos locales a un agente MQTT de nivel industrial, agregar proceso perimetral y configurar el flujo de datos bidireccional con una variedad de servicios en la nube.

De forma predeterminada, los comandos de la CLI de IoT Operations comprobarán periódicamente si hay disponible una nueva versión de extensión. Este comportamiento se puede deshabilitar con az config set iotops.check_latest=false.

Comandos

Nombre Description Tipo Estado
az iot ops asset

Administrar recursos.

Extensión Vista previa
az iot ops asset create

Cree un recurso.

Extensión Vista previa
az iot ops asset data-point

Administrar puntos de datos en un recurso.

Extensión Vista previa
az iot ops asset data-point add

Agregue un punto de datos a un recurso.

Extensión Vista previa
az iot ops asset data-point export

Exportar puntos de datos en un recurso.

Extensión Vista previa
az iot ops asset data-point import

Importe puntos de datos en un recurso.

Extensión Vista previa
az iot ops asset data-point list

Enumere los puntos de datos de un recurso.

Extensión Vista previa
az iot ops asset data-point remove

Quite un punto de datos de un recurso.

Extensión Vista previa
az iot ops asset delete

Eliminar un recurso.

Extensión Vista previa
az iot ops asset endpoint

Administrar perfiles de punto de conexión de recursos.

Extensión Vista previa
az iot ops asset endpoint certificate

Administrar certificados propiedad en un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset endpoint certificate add

Agregue un certificado propiedad a un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset endpoint certificate list

Enumera los certificados propiedad de un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset endpoint certificate remove

Quite un certificado de propiedad en un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset endpoint create

Cree un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset endpoint delete

Elimine un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset endpoint query

Consulte Resource Graph para los puntos de conexión de recursos.

Extensión Vista previa
az iot ops asset endpoint show

Mostrar un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset endpoint update

Actualice un punto de conexión de recurso.

Extensión Vista previa
az iot ops asset event

Administrar eventos en un recurso.

Extensión Vista previa
az iot ops asset event add

Agregue un evento a un recurso.

Extensión Vista previa
az iot ops asset event export

Exportar eventos en un recurso.

Extensión Vista previa
az iot ops asset event import

Importar eventos en un recurso.

Extensión Vista previa
az iot ops asset event list

Enumerar eventos en un recurso.

Extensión Vista previa
az iot ops asset event remove

Quite un evento en un recurso.

Extensión Vista previa
az iot ops asset query

Consulte resource Graph para los recursos.

Extensión Vista previa
az iot ops asset show

Mostrar un recurso.

Extensión Vista previa
az iot ops asset update

Actualice un recurso.

Extensión Vista previa
az iot ops check

Evalúe el estado en tiempo de ejecución del lado clúster de los servicios de operaciones de IoT implementados.

Extensión Vista previa
az iot ops init

Arranque, configure e implemente operaciones de IoT en el clúster habilitado para arc de destino.

Extensión Vista previa
az iot ops mq

Herramientas específicas de MQ.

Extensión Vista previa
az iot ops mq get-password-hash

Genera un hash PBKDF2 de la frase de contraseña que aplica PBKDF2-HMAC-SHA512. Se utiliza una sal de 128 bits de os.urandom.

Extensión Vista previa
az iot ops mq stats

Mostrar estadísticas en ejecución de dmqtt.

Extensión Vista previa
az iot ops support

Las operaciones de IoT admiten el espacio de comandos.

Extensión Vista previa
az iot ops support create-bundle

Crea un archivo zip de agrupación de compatibilidad estándar para su uso en la solución de problemas y diagnósticos.

Extensión Vista previa
az iot ops verify-host

Ejecuta un conjunto de comprobaciones de host de clúster para la compatibilidad de implementación de operaciones de IoT.

Extensión Vista previa

az iot ops check

Vista previa

El grupo de comandos "iot ops" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Evalúe el estado en tiempo de ejecución del lado clúster de los servicios de operaciones de IoT implementados.

El comando muestra de forma predeterminada una vista de resumen fácil de usar del servicio seleccionado. Se puede solicitar más detalles a través de --detail-level.

{API de servicio compatibles}

  • 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}]

Ejemplos

Uso básico. Comprueba el estado de "mq" con la salida de resumen.

az iot ops check

Evalúa "mq" como ejemplo anterior, pero la salida está optimizada para CI.

az iot ops check --as-object

Comprueba el estado y la configuración del "dataprocessor" con una salida detallada.

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

Igual que en el ejemplo anterior, excepto restringir los resultados al recurso "pipeline".

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

Use el nombre del recurso para restringir los resultados al recurso "pipeline" que coincida exactamente con el nombre "pipeline".

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

Use el nombre del recurso para restringir los resultados a los nombres de recursos que comienzan por "pipeline-name".

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

Use el patrón global "?" para restringir los resultados a los nombres de recursos que contienen "canalización" y terminan con un solo carácter.

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

Parámetros opcionales

--as-object

Comprobación de contenido y validaciones de salida en una estructura de datos descriptivo de CI.

valores aceptados: false, true
--context

Nombre de contexto de Kubeconfig que se va a usar para la comunicación de clúster k8s. Si no se proporciona ningún contexto current_context se usa.

--detail-level

Controla el nivel de detalle mostrado en la salida de comprobación. Elija 0 para una vista de resumen (salida mínima), 1 para obtener una vista detallada (información más completa) o 2 para una vista detallada (toda la información disponible).

valores aceptados: 0, 1, 2
valor predeterminado: 0
--ops-service --svc

Implementación del servicio IoT Operations que se evaluará.

valores aceptados: akri, dataprocessor, deviceregistry, lnm, mq, opcua
valor predeterminado: mq
--post

Ejecute comprobaciones posteriores a la implementación.

valores aceptados: false, true
--pre

Ejecute comprobaciones de requisitos previos para determinar si se cumplen los requisitos mínimos de una implementación de servicio.

valores aceptados: false, true
--resource-name --rn

Solo se ejecutan comprobaciones para el nombre de recurso específico. El nombre distingue mayúsculas de minúsculas. Se admiten los patrones de Glob '' y '?'. Nota: Solo se permiten caracteres alfanuméricos, guiones, "?" y "".

--resources

Ejecute solo comprobaciones en tipos de recursos específicos. Use valores separados por espacios.

valores aceptados: asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot ops init

Vista previa

El grupo de comandos "iot ops" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Arranque, configure e implemente operaciones de IoT en el clúster habilitado para arc de destino.

Para obtener recursos adicionales, incluido cómo habilitar un clúster, 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]

Ejemplos

Entrada mínima para la configuración completa. Esto incluye la configuración de Key Vault, la implementación del controlador CSI, la configuración tls y la implementación de operaciones de IoT.

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

La misma configuración que el ejemplo anterior, excepto con el uso de un identificador de aplicación existente y una marca para incluir un servidor PLC simulado como parte de la implementación. Incluir el identificador de aplicación impedirá que "init" cree un registro de aplicación.

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

Para omitir la implementación y centrarse solo en el controlador CSI de Key Vault y los flujos de trabajo de configuración de TLS, pase sencillo "--no-deploy". Esto puede ser útil al desear implementar desde una herramienta diferente, como Portal.

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

Para implementar solo operaciones de IoT en un clúster que ya se ha preajustado, simplemente omita "--kv-id" e incluya "--no-tls".

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

Use "--no-block" para realizar otro trabajo mientras la implementación está en marcha frente a la espera de que finalice la implementación antes de iniciar el otro trabajo.

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

Para evitar llamar a MS Graph, como para escenarios de CI en los que los permisos de la entidad de servicio de az cli están limitados o se debe volver a usar una entidad de servicio existente, proporcione todos los elementos "--sp-app-id", "-sp-object-id" y "--sp-secret". Estos valores deben reflejar la entidad de servicio deseada que se usará para la configuración del controlador CSI de Key Vault.

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 requeridos

--cluster

Nombre de clúster de destino para la implementación de operaciones de IoT.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--ca-dir

El directorio local en el que se colocará la ENTIDAD de certificación de prueba generada y la clave privada. Si no se proporciona ningún directorio, no se escribirán archivos en el disco. Aplicable cuando no se proporciona --ca-file y --ca-key-file.

--ca-file

Ruta de acceso al archivo ca deseado en formato PEM.

--ca-key-file

Ruta de acceso al archivo de clave privada de CA en formato PEM. ! ¡Obligatorio! cuando se proporciona --ca-file.

--ca-valid-days

Opción para controlar la duración en días de la ca x509 generada por init. Aplicable si no se proporcionan --ca-file y --ca-key-file.

valor predeterminado: 365
--cluster-namespace

El espacio de nombres del clúster en el que se implementará la infraestructura de operaciones de IoT. Debe estar en minúscula.

valor predeterminado: azure-iot-operations
--context

Nombre de contexto de Kubeconfig que se va a usar para la comunicación de clúster k8s. Si no se proporciona ningún contexto current_context se usa.

--csi-driver-ver

Versión del controlador CSI.

valor predeterminado: 1.5.2
--custom-location

Nombre de ubicación personalizado correspondiente a la implementación de operaciones de IoT. El valor predeterminado está en el formato '{cluster_name}-ops-init-cl'.

--disable-rotation

Marca para deshabilitar la rotación de secretos.

valores aceptados: false, true
--disable-rsync-rules

Las reglas de sincronización de recursos no se incluirán en la implementación.

valores aceptados: false, true
--dp-instance

Nombre de instancia para el procesador de datos. El valor predeterminado está en el formato '{cluster_name}-ops-init-processor'.

--ensure-latest

Asegúrese de que la CLI de IoT Ops más reciente está instalada, lo que genera un error si hay disponible una actualización.

valores aceptados: false, true
--kubernetes-distro

La distribución de Kubernetes que se va a usar para la configuración de Akri. La distribución seleccionada implica la ruta de acceso de socket del entorno de ejecución del contenedor predeterminada cuando no se proporciona ningún valor de socket --runtime-socket.

valores aceptados: k3s, k8s, microk8s
valor predeterminado: k8s
--kv-id

Id. de recurso de ARM de Key Vault. Al proporcionar este identificador de recurso, el cliente podrá configurar todos los recursos necesarios y la configuración del lado del clúster para habilitar el controlador CSI de Key Vault para operaciones de IoT.

--kv-spc-secret-name

Nombre del secreto de Key Vault que se va a usar como secreto de SPC predeterminado. Si el secreto no existe, se creará con un valor de marcador de posición seguro criptográficamente.

valor predeterminado: azure-iot-operations
--location

Ubicación de ARM que se usará para el material adjunto RPSaaS aprovisionado. Si no se proporciona la ubicación del clúster conectado, se usará.

--mq-authn

Nombre de la autenticación mq. El valor predeterminado es "authn".

--mq-backend-part

Particiones de back-end de MQ.

valor predeterminado: 2
--mq-backend-rf

Factor de redundancia de back-end de MQ.

valor predeterminado: 2
--mq-backend-workers

Trabajos de back-end de MQ.

valor predeterminado: 2
--mq-broker

Nombre del agente mq. El valor predeterminado es "broker".

--mq-frontend-replicas

Réplicas de front-end de MQ.

valor predeterminado: 2
--mq-frontend-server

Nombre del servidor front-end mq. El valor predeterminado es "mq-dmqtt-frontend".

--mq-frontend-workers

Trabajos de front-end de MQ.

valor predeterminado: 2
--mq-insecure

Cuando se habilite la implementación de mq, se incluirá un agente de escucha enlazado al puerto 1883 sin autenticación ni autenticaciónZ. El valor encryptInternalTraffic del agente se establecerá en false. Solo para cargas de trabajo que no son de producción.

valores aceptados: false, true
--mq-instance

Nombre de la instancia de mq. El valor predeterminado está en el formato "init-{hash}-mq-instance".

--mq-listener

Nombre del agente de escucha mq. El valor predeterminado es "agente de escucha".

--mq-mem-profile

Perfil de memoria mq.

valores aceptados: high, low, medium, tiny
valor predeterminado: medium
--mq-mode

Modo mq de funcionamiento.

valores aceptados: auto, distributed
valor predeterminado: distributed
--mq-service-type

Tipo de servicio MQ.

valores aceptados: clusterIp, loadBalancer, nodePort
valor predeterminado: clusterIp
--no-block

Vuelva inmediatamente después de que se haya iniciado la implementación de operaciones de IoT.

valores aceptados: false, true
--no-deploy

Se omitirá el flujo de trabajo de implementación de operaciones de IoT.

valores aceptados: false, true
--no-progress

Deshabilite la barra de progreso de inicialización.

valores aceptados: false, true
--no-tls

Se omitirá el flujo de trabajo de configuración de TLS.

valores aceptados: false, true
--opcua-discovery-url

Configura un punto de conexión de servidor OPC-UA para los controladores de detección de Akri. Si no se proporciona y se establece --simulate-plc, este valor se convierte en 'opc.tcp://opcplc-0000000. {cluster_namespace}:50000'.

--rotation-int

Intervalo de sondeo de rotación.

valor predeterminado: 1h
--runtime-socket

Ruta de acceso de nodo predeterminada del socket en tiempo de ejecución del contenedor. Si no se proporciona (valor predeterminado), la ruta de acceso del socket viene determinada por --kubernetes-distro.

--show-template

Marca cuando se establece, generará la plantilla prevista para la implementación.

valores aceptados: false, true
--simulate-plc

Marca cuando se establezca, configurará el instalador del agente de OPC-UA para poner en marcha un servidor PLC.

valores aceptados: false, true
--sp-app-id

Identificador de la aplicación de entidad de servicio. Si se proporciona, se usará para la configuración del controlador CSI. De lo contrario, se creará un registro de aplicación. Obligatorio si la entidad de seguridad que ha iniciado sesión no tiene permisos para consultar el grafo.

--sp-object-id

Identificador de objeto de entidad de servicio (sp). Si se proporciona, se usará para la configuración del controlador CSI. De lo contrario, se consultará el identificador de objeto desde el identificador de la aplicación, lo que crea el sp si no existe uno. Obligatorio si la entidad de seguridad que ha iniciado sesión no tiene permisos para consultar el grafo. Use az ad sp show --id <app Id> --query id -o tsv para generar el identificador de objeto adecuado. Como alternativa, puede ir a Aplicaciones empresariales en el inquilino de Entra Id.

--sp-secret

Secreto correspondiente al identificador de aplicación de entidad de servicio proporcionado. Si se proporciona, se usará para la configuración del controlador CSI. De lo contrario, se creará un nuevo secreto. Obligatorio si la entidad de seguridad que ha iniciado sesión no tiene permisos para consultar el grafo.

--sp-secret-valid-days

Opción para controlar la duración en días del secreto de la entidad de servicio generada por init. Aplicable si no se proporciona --sp-secret.

valor predeterminado: 365
--target

Nombre de destino del orquestador de operaciones. El valor predeterminado está en el formato '{cluster_name}-ops-init-target'.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot ops verify-host

Vista previa

El grupo de comandos "iot ops" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Ejecuta un conjunto de comprobaciones de host de clúster para la compatibilidad de implementación de operaciones de IoT.

Diseñado para ejecutarse directamente en un host de clúster de destino. El comando puede pedir que aplique un conjunto de acciones con privilegios, como instalar una dependencia. En este caso, la CLI debe ejecutarse con permisos elevados. Por ejemplo, sudo AZURE_EXTENSION_DIR=~/.azure/cliextensions az iot ops verify-host.

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

Parámetros opcionales

--no-progress

Deshabilite la representación visual del trabajo.

valores aceptados: false, true
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.