Compartir a través de

az iot hub state

  • Habilitación de características

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 hub state. Obtenga más información sobre las extensiones.

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

Administre el estado de una instancia de IoT Hub.

Para obtener más información, consulte aka.ms/aziotcli-iot-hub-state.

Comandos

Nombre Description Tipo Estado
az iot hub state export

Exporte el estado de una instancia de IoT Hub a un archivo.

 Extension Experimental
az iot hub state import

Importe un estado del centro de conectividad de un archivo a una instancia de IoT Hub.

 Extension Experimental
az iot hub state migrate

Migre el estado de un centro a otro sin guardarlo en un archivo.

 Extension Experimental

az iot hub state export

Habilitación de características

El grupo de comandos "estado del centro de iot" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Exporte el estado de una instancia de IoT Hub a un archivo.

De forma predeterminada, el estado exportado incluirá: plantilla de arm para concentrador, configuraciones de concentrador (incluidas configuraciones de ADM e implementaciones perimetrales), información del dispositivo (incluidas las identidades de dispositivo, los dispositivos gemelos, las identidades de módulo y los módulos gemelos).

Para obtener más información, consulte aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Ejemplos

Exporte el estado admitido del centro especificado al archivo especificado.

az iot hub state export -n {iothub_name} -f {state_filename}

Exporte el estado admitido del centro especificado al archivo especificado y sobrescriba el contenido del archivo.

az iot hub state export -n {iothub_name} -f {state_filename} -r

Exporte solo los dispositivos y configuraciones del centro especificado al archivo especificado.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

Parámetros requeridos

--state-file -f

Ruta de acceso al archivo donde se almacenará la información de estado.

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.

--aspects

Aspectos del concentrador (separados por espacio).

Propiedad Valor
Valores aceptados: arm, configurations, devices
--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
--replace -r

Si se establece esta marca, el comando sobrescribirá el contenido del archivo de salida.

Propiedad Valor
Valor predeterminado: False
--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 hub state import

Habilitación de características

El grupo de comandos "estado del centro de iot" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Importe un estado del centro de conectividad de un archivo a una instancia de IoT Hub.

Si se especifica el aspecto del brazo, se creará el concentrador si no existe.

De forma predeterminada, el estado importado incluirá: plantilla de arm para concentrador, configuraciones de concentrador (incluidas configuraciones de ADM e implementaciones perimetrales), información del dispositivo (incluidas las identidades de dispositivo, los dispositivos gemelos, las identidades de módulo y los módulos gemelos).

Para los puntos de conexión importados con la autenticación de identidad asignada por el sistema, el centro especificado debe tener los permisos correctos. De lo contrario, se producirá un error en el comando.

Los puntos de conexión privados se omitirán en el proceso de importación.

Para obtener más información, consulte aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Ejemplos

Importe el estado admitido desde el archivo especificado al centro especificado.

az iot hub state import -n {iothub_name} -f {state_filename}

Importe el estado admitido del archivo especificado al centro especificado y sobrescriba el estado anterior del centro. Todos los certificados, configuraciones y dispositivos se eliminarán antes de cargar el nuevo estado.

az iot hub state import -n {iothub_name} -f {state_filename} -r

Importe solo la plantilla de arm desde el archivo especificado al centro especificado. Tenga en cuenta que esto creará un nuevo centro si no existe. El archivo puede contener los dispositivos y las configuraciones, pero se omitirán.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

Importe solo los dispositivos y configuraciones del archivo especificado al centro especificado. Tenga en cuenta que esto NO creará un nuevo centro si no existe y se producirá un error en el comando. El archivo puede contener la plantilla de arm, pero eso se omitirá.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

Parámetros requeridos

--state-file -f

Ruta de acceso al archivo donde se almacenará la información de estado.

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.

--aspects

Aspectos del concentrador (separados por espacio).

Propiedad Valor
Valores aceptados: arm, configurations, devices
--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
--replace -r

Si se establece esta marca, el comando eliminará los dispositivos, configuraciones y certificados actuales del centro de destino.

Propiedad Valor
Valor predeterminado: False
--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 hub state migrate

Habilitación de características

El grupo de comandos "estado del centro de iot" es experimental y está en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Migre el estado de un centro a otro sin guardarlo en un archivo.

Si se especifica el aspecto del brazo, se creará el concentrador si no existe.

De forma predeterminada, el estado migrado incluirá: plantilla de arm para concentrador, configuraciones de concentrador (incluidas configuraciones de ADM e implementaciones perimetrales), información del dispositivo (incluidas las identidades de dispositivo, los dispositivos gemelos, las identidades de módulo y los módulos gemelos).

Para los puntos de conexión migrados con la autenticación de identidad asignada por el sistema, el centro especificado debe tener los permisos correctos. De lo contrario, se producirá un error en el comando.

Los puntos de conexión privados se omitirán en el proceso de migración.

Si tiene problemas para migrar, use los comandos de exportación e importación para tener un archivo como copia de seguridad.

Para obtener más información, consulte aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub --dh]
                         [--destination-hub-login --dl]
                         [--destination-resource-group --dg]
                         [--og --origin-resource-group]
                         [--oh --origin-hub]
                         [--ol --origin-hub-login]
                         [--replace]

Ejemplos

Migre el estado admitido del centro de origen al centro de destino.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

Migre el estado admitido del centro de origen al centro de destino y sobrescriba el estado anterior del centro. Todos los certificados, configuraciones y dispositivos del centro de destino se eliminarán antes de cargar el nuevo estado.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

Migre solo la plantilla de arm desde el centro de origen al centro de destino. Tenga en cuenta que esto creará un nuevo centro si el centro de destino no existe. El centro de origen puede contener los dispositivos y las configuraciones, pero se omitirán.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

Migre solo los dispositivos y configuraciones del centro de origen al centro de destino. Tenga en cuenta que esto NO creará un nuevo centro si el centro de destino no existe y se producirá un error en el comando. Se omitirá la plantilla de arm para el centro de origen.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

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.

--aspects

Aspectos del concentrador (separados por espacio).

Propiedad Valor
Valores aceptados: arm, configurations, devices
--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
--destination-hub --dh

Nombre de IoT Hub al que se copiará el estado del centro de origen.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--destination-hub-login --dl

Este comando admite una cadena de conexión de entidad con derechos para realizar acciones en el centro de destino. Use para evitar el inicio de sesión a través de az login para esta instancia de IoT Hub. 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 --destination-hub.

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

Nombre del grupo de recursos de IoT Hub al que se copiará el estado del centro de origen. Si no se proporciona, usará el grupo de recursos de IoT Hub de origen.

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

Nombre del grupo de recursos de IoT Hub que se copiará.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--oh --origin-hub

Nombre de IoT Hub que se copiará.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--ol --origin-hub-login

Este comando admite una cadena de conexión de entidad con derechos para realizar acciones en el centro de origen. Use para evitar el inicio de sesión a través de az login para esta instancia de IoT Hub. 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 --origin-hub.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--replace -r

Si se establece esta marca, el comando eliminará los dispositivos, configuraciones y certificados actuales del centro de destino.

Propiedad Valor
Valor predeterminado: False
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