Compartir a través de

az iot edge

Note

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

Administrar soluciones IoT en IoT Edge.

Comandos

Nombre Description Tipo Estado
az iot edge deployment

Administrar implementaciones de IoT Edge a escala.

 Extension GA
az iot edge deployment create

Cree una implementación de IoT Edge en una instancia de IoT Hub de destino.

 Extension GA
az iot edge deployment delete

Elimine una implementación de IoT Edge.

 Extension GA
az iot edge deployment list

Enumere las implementaciones de IoT Edge en una instancia de IoT Hub.

 Extension GA
az iot edge deployment show

Obtenga los detalles de una implementación de IoT Edge.

 Extension GA
az iot edge deployment show-metric

Evalúe una métrica del sistema de destino definida en una implementación de IoT Edge.

 Extension GA
az iot edge deployment update

Actualice las propiedades especificadas de una implementación de IoT Edge.

 Extension GA
az iot edge devices

Comandos para administrar dispositivos IoT Edge.

 Extension GA
az iot edge devices create

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

 Extension Experimental
az iot edge export-modules

Exporte la configuración de los módulos perimetrales en un único dispositivo perimetral.

 Extension GA
az iot edge set-modules

Establezca módulos perimetrales en un único dispositivo.

 Extension GA

az iot edge export-modules

Exporte la configuración de los módulos perimetrales en un único dispositivo perimetral.

La salida de configuración del módulo gemelo se puede usar directamente como el contenido de "az iot edge set-modules".

az iot edge export-modules --device-id
                           [--auth-type {key, login}]
                           [--hub-name]
                           [--login]
                           [--resource-group]

Ejemplos

Exporte la configuración del módulo gemelo en un dispositivo de destino.

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

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

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--hub-name -n

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

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--login -l

Este comando admite una cadena de conexión de entidad 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.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--resource-group -g

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

Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot edge set-modules

Establezca módulos perimetrales en un único dispositivo.

El contenido de los módulos es json y en forma de {"modulesContent":{...}} o {"content":{"modulesContent":{...}}}.

De forma predeterminada, las propiedades de los módulos del sistema $edgeAgent y $edgeHub se validan con esquemas instalados con la extensión de IoT. Esto se puede deshabilitar mediante el modificador --no-validation.

Nota: Tras la ejecución, el comando generará la colección de módulos aplicados al dispositivo.

az iot edge set-modules --content
                        --device-id
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--resource-group]

Ejemplos

Pruebe los módulos perimetrales durante el desarrollo estableciendo módulos en un dispositivo de destino.

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

Parámetros requeridos

--content -k

Contenido de implementación de IoT Edge. Proporcione la ruta de acceso del archivo o json sin formato.

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

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

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--hub-name -n

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

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--login -l

Este comando admite una cadena de conexión de entidad 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.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--resource-group -g

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

Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False