az iot edge devices

  • Referencia

Nota:

Esta referencia forma parte de la extensión azure-iot 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 edge devices . Obtenga más información sobre las extensiones.

Comandos para administrar dispositivos IoT Edge.

Comandos

Nombre Description Tipo Estado
az iot edge devices create

Cree y configure varios dispositivos perimetrales en una instancia de IoT Hub.

 Extensión Habilitación de características

az iot edge devices create

Habilitación de características

Este comando es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree y configure varios dispositivos perimetrales en una instancia de IoT Hub.

Esta operación acepta argumentos de dispositivo insertados o un archivo de configuración de dispositivos perimetrales en formato YAML o JSON. Los argumentos de comandos insertados (como "--device-auth") tendrán prioridad e invalidarán las propiedades del archivo de configuración si se proporcionan. Puede encontrar un archivo de configuración de ejemplo aquí: https://aka.ms/aziotcli-edge-devices-config Revise ejemplos y descripciones de parámetros para obtener más información sobre cómo utilizar completamente esta operación.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {false, true}]
                           [--yes {false, true}]

Ejemplos

Crear un par de dispositivos perimetrales mediante la autenticación de clave simétrica (valor predeterminado)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

Cree una lista plana de dispositivos perimetrales mediante la autenticación de certificados autofirmados con varias configuraciones de propiedades perimetrales, mediante argumentos insertados.

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

Elimine todas las identidades de dispositivo existentes en un centro de conectividad y cree nuevos dispositivos basados en un archivo de configuración (con barras de progreso y salida de visualización).

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

Cree un grupo de dispositivos perimetrales anidados con implementaciones de módulos personalizados, que contienen 2 dispositivos primarios con 1 dispositivo secundario cada uno, mediante argumentos insertados. También especifica la ruta de acceso de salida para los conjuntos de certificados de dispositivo.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

Cree una configuración sencilla de dispositivo perimetral anidado con una ENTIDAD de certificación raíz existente, con la autenticación x509 y especifique una ruta de salida de agrupación de dispositivos personalizada.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

Parámetros opcionales

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

Valores aceptados: key, login
Valor predeterminado: key
--cfg --config --config-file

Ruta de acceso al archivo de configuración de dispositivos. Archivo de configuración de ejemplo: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Elimina todos los dispositivos del centro de destino antes de crear nuevos dispositivos.

Valores aceptados: false, true
Valor predeterminado: False
--dct --device-config-template

Ruta de acceso al archivo config.toml de IoT Edge que se usará como base para las configuraciones de dispositivo perimetral.

--dea --default-agent --default-edge-agent

El agente perimetral predeterminado para dispositivos perimetrales creados si no se especifica individualmente.

--device -d

Pares clave=valor separados por espacios correspondientes a las propiedades del dispositivo perimetral que se van a crear. Se admiten los siguientes valores de clave: id (device_id), deployment (json insertado o ruta de acceso al archivo), hostname, parent (device_id), (dirección URL de imagen) edge_agent y container_auth (json insertado o ruta de acceso al archivo). --device se puede usar 1 o más veces. Revise ejemplos de ayuda para el uso completo de parámetros: estos parámetros también hacen referencia a sus valores correspondientes en nuestro archivo de configuración de ejemplo: https://aka.ms/aziotcli-edge-devices-config.

--device-auth --device-auth-type

Mecanismo de autorización del dispositivo al concentrador.

Valores aceptados: shared_private_key, x509_thumbprint
--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--out --output-path

Ruta de acceso del directorio a los conjuntos de configuración del dispositivo de salida. Si no se especifica este valor, no se creará ninguna salida de archivo.

--rc --root-cert

Ruta de acceso al certificado de clave pública raíz para firmar certificados de dispositivo perimetral anidados.

--resource-group -g

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

--rk --root-key

Ruta de acceso a la clave privada raíz para firmar certificados de dispositivo perimetral anidados.

--root-pass --rp

Contraseña de clave raíz.

--vis --visualize -v

Muestra visualizaciones de dispositivos y progreso de varias tareas (creación de dispositivos, configuración de elementos primarios, actualización de configuraciones, etc.).

Valores aceptados: false, true
Valor predeterminado: False
--yes -y

No solicite confirmación cuando se use el modificador --clean para eliminar los dispositivos concentradores existentes.

Valores aceptados: false, true
Valor predeterminado: False
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.