az iot hub

Referencia

Nota:

Este grupo de comandos tiene comandos definidos en la CLI de Azure y al menos una extensión. Instale cada extensión para beneficiarse de sus funcionalidades extendidas. Obtenga más información sobre las extensiones.

Administrar centros de IoT de Azure.

Comandos

Nombre	Description	Tipo	Estado
az iot hub certificate	Administre los certificados de IoT Hub.	Núcleo y extensión	GA
az iot hub certificate create	Cree o cargue un certificado de Azure IoT Hub.	Principal	GA
az iot hub certificate delete	Elimina un certificado de Azure IoT Hub.	Principal	GA
az iot hub certificate generate-verification-code	Genera un código de verificación para un certificado de Azure IoT Hub.	Principal	GA
az iot hub certificate list	Enumera todos los certificados contenidos en una instancia de Azure IoT Hub.	Principal	GA
az iot hub certificate root-authority	Administre la entidad raíz del certificado para una instancia de IoT Hub.	Extensión	En desuso
az iot hub certificate root-authority set	Establezca la entidad raíz del certificado para una instancia de IoT Hub en una versión específica.	Extensión	En desuso
az iot hub certificate root-authority show	Mostrar la entidad raíz del certificado actual para una instancia de IoT Hub.	Extensión	En desuso
az iot hub certificate show	Muestra información sobre un certificado de Azure IoT Hub determinado.	Principal	GA
az iot hub certificate update	Actualice un certificado de Azure IoT Hub.	Principal	GA
az iot hub certificate verify	Comprueba un certificado de Azure IoT Hub.	Principal	GA
az iot hub configuration	Administración de la configuración de administración automática a escala de dispositivos IoT.	Extensión	GA
az iot hub configuration create	Cree una configuración de administración automática de dispositivos IoT en un centro de IoT de destino.	Extensión	GA
az iot hub configuration delete	Elimine una configuración de dispositivo IoT.	Extensión	GA
az iot hub configuration list	Enumere las configuraciones de administración automática de dispositivos de IoT en una instancia de IoT Hub.	Extensión	GA
az iot hub configuration show	Obtenga los detalles de una configuración de administración automática de dispositivos IoT.	Extensión	GA
az iot hub configuration show-metric	Evalúe una métrica de usuario o sistema de destino definida en una configuración de dispositivo IoT.	Extensión	GA
az iot hub configuration update	Actualice las propiedades especificadas de una configuración de administración automática de dispositivos IoT.	Extensión	GA
az iot hub connection-string	Administrar cadena de conexión de IoT Hub.	Extensión	GA
az iot hub connection-string show	Muestre los cadena de conexión de los centros de IoT especificados mediante el nombre de directiva y la clave especificados.	Extensión	GA
az iot hub consumer-group	Administre los grupos de consumidores del centro de eventos de un centro de IoT.	Principal	GA
az iot hub consumer-group create	Cree un grupo de consumidores del centro de eventos.	Principal	GA
az iot hub consumer-group delete	Elimine un grupo de consumidores del centro de eventos.	Principal	GA
az iot hub consumer-group list	Enumera los grupos de consumidores del centro de eventos.	Principal	GA
az iot hub consumer-group show	Obtenga los detalles de un grupo de consumidores del centro de eventos.	Principal	GA
az iot hub create	Cree una instancia de Azure IoT Hub.	Principal	GA
az iot hub delete	Elimine un centro de IoT.	Principal	GA
az iot hub device-identity	Administre los dispositivos IoT.	Extensión	GA
az iot hub device-identity children	Administrar relaciones de dispositivos secundarios para dispositivos IoT Edge.	Extensión	GA
az iot hub device-identity children add	Agregue dispositivos como elementos secundarios a un dispositivo perimetral de destino.	Extensión	GA
az iot hub device-identity children list	Genera la colección de dispositivos secundarios asignados.	Extensión	GA
az iot hub device-identity children remove	Quite los dispositivos secundarios de un dispositivo perimetral de destino.	Extensión	GA
az iot hub device-identity connection-string	Administrar la cadena de conexión del dispositivo IoT.	Extensión	GA
az iot hub device-identity connection-string show	Mostrar un cadena de conexión de dispositivo ioT Hub determinado.	Extensión	GA
az iot hub device-identity create	Cree un dispositivo en una instancia de IoT Hub.	Extensión	GA
az iot hub device-identity delete	Elimine un dispositivo ioT Hub.	Extensión	GA
az iot hub device-identity export	Exporte todas las identidades de dispositivo de una instancia de IoT Hub a un contenedor de blobs de Azure Storage.	Extensión	GA
az iot hub device-identity import	Importe identidades de dispositivo a IoT Hub desde un blob de contenedor de almacenamiento.	Extensión	GA
az iot hub device-identity list	Enumeración de dispositivos en una instancia de IoT Hub.	Extensión	GA
az iot hub device-identity parent	Administrar las relaciones de dispositivos primarios para dispositivos IoT.	Extensión	GA
az iot hub device-identity parent set	Establezca el dispositivo primario de un dispositivo de destino.	Extensión	GA
az iot hub device-identity parent show	Obtenga el dispositivo primario de un dispositivo de destino.	Extensión	GA
az iot hub device-identity renew-key	Renueve las claves de destino de un dispositivo de IoT Hub con autenticación sas.	Extensión	GA
az iot hub device-identity show	Obtenga los detalles de un dispositivo ioT Hub.	Extensión	GA
az iot hub device-identity update	Actualice un dispositivo IoT Hub.	Extensión	GA
az iot hub device-twin	Administre la configuración de dispositivos gemelos de IoT.	Extensión	GA
az iot hub device-twin list	Enumeración de dispositivos gemelos en una instancia de IoT Hub.	Extensión	GA
az iot hub device-twin replace	Reemplace la definición del dispositivo gemelo por json de destino.	Extensión	GA
az iot hub device-twin show	Obtenga una definición de dispositivo gemelo.	Extensión	GA
az iot hub device-twin update	Actualice las propiedades y etiquetas deseadas del dispositivo gemelo.	Extensión	GA
az iot hub devicestream	Administre flujos de dispositivos de una instancia de IoT Hub.	Principal	Vista previa
az iot hub devicestream show	Obtenga los puntos de conexión de flujos de dispositivo de IoT Hub.	Principal	Vista previa
az iot hub digital-twin	Manipule e interactúe con el gemelo digital de un dispositivo ioT Hub.	Extensión	GA
az iot hub digital-twin invoke-command	Invoque un comando raíz o de nivel de componente de un dispositivo gemelo digital.	Extensión	GA
az iot hub digital-twin show	Mostrar el gemelo digital de un dispositivo ioT Hub.	Extensión	GA
az iot hub digital-twin update	Actualice las propiedades de lectura y escritura de un dispositivo gemelo digital mediante la especificación de revisión JSON.	Extensión	GA
az iot hub distributed-tracing	Administre la configuración distribuida por dispositivo.	Extensión	Vista previa
az iot hub distributed-tracing show	Obtiene la configuración de seguimiento distribuido de un dispositivo.	Extensión	Vista previa
az iot hub distributed-tracing update	Actualice las opciones de seguimiento distribuido de un dispositivo.	Extensión	Vista previa
az iot hub generate-sas-token	Genere un token de SAS para un ioT Hub de destino, un dispositivo o un módulo.	Extensión	GA
az iot hub identity	Administración de identidades de una instancia de Azure IoT Hub.	Principal	GA
az iot hub identity assign	Asigne identidades administradas a una instancia de IoT Hub.	Principal	GA
az iot hub identity remove	Quite las identidades administradas de una instancia de IoT Hub.	Principal	GA
az iot hub identity show	Mostrar las propiedades de identidad de una instancia de IoT Hub.	Principal	GA
az iot hub invoke-device-method	Invoque un método de dispositivo.	Extensión	GA
az iot hub invoke-module-method	Invoque un método de módulo.	Extensión	GA
az iot hub job	Administración de trabajos de IoT Hub (v2).	Extensión	GA
az iot hub job cancel	Cancelar un trabajo de IoT Hub.	Extensión	GA
az iot hub job create	Cree y programe un trabajo de IoT Hub para su ejecución.	Extensión	GA
az iot hub job list	Enumerar los trabajos históricos de una instancia de IoT Hub.	Extensión	GA
az iot hub job show	Mostrar detalles de un trabajo de IoT Hub existente.	Extensión	GA
az iot hub list	Enumeración de centros de IoT.	Principal	GA
az iot hub list-skus	Enumere los planes de tarifa disponibles.	Principal	GA
az iot hub manual-failover	Inicie una conmutación por error manual para IoT Hub a la región de recuperación ante desastres emparejada geográficamente.	Principal	GA
az iot hub message-endpoint	Administre puntos de conexión personalizados de una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint create	Agregue un punto de conexión a una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint create cosmosdb-container	Agregue un punto de conexión de contenedor de Cosmos DB para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint create eventhub	Agregue un punto de conexión del centro de eventos para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint create servicebus-queue	Agregue un punto de conexión de cola de Service Bus para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint create servicebus-topic	Agregue un punto de conexión de tema de Service Bus para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint create storage-container	Agregue un punto de conexión de contenedor de almacenamiento para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint delete	Elimine todo o un punto de conexión específico para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint list	Obtenga información sobre todos los puntos de conexión de una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint show	Obtenga información sobre el punto de conexión mencionado para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint update	Actualice las propiedades de un punto de conexión existente para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint update cosmosdb-container	Actualice las propiedades de un punto de conexión de contenedor de Cosmos DB existente para ioT Hub.	Extensión	Vista previa
az iot hub message-endpoint update eventhub	Actualice las propiedades de un punto de conexión de Centro de eventos existente para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-endpoint update servicebus-queue	Actualice las propiedades de un punto de conexión de cola de Service Bus existente para ioT Hub.	Extensión	Vista previa
az iot hub message-endpoint update servicebus-topic	Actualice las propiedades de un punto de conexión de tema de Service Bus existente para ioT Hub.	Extensión	Vista previa
az iot hub message-endpoint update storage-container	Actualice las propiedades de un punto de conexión de contenedor de almacenamiento existente para ioT Hub.	Extensión	Vista previa
az iot hub message-enrichment	Administre el enriquecimiento de mensajes para los puntos de conexión de una instancia de IoT Hub.	Principal	GA
az iot hub message-enrichment create	Cree un enriquecimiento de mensajes para los puntos de conexión elegidos en ioT Hub.	Principal	GA
az iot hub message-enrichment delete	Elimine un enriquecimiento de mensajes en ioT Hub (por clave).	Principal	GA
az iot hub message-enrichment list	Obtenga información sobre todos los enriquecimientos de mensajes para IoT Hub.	Principal	GA
az iot hub message-enrichment update	Actualice un enriquecimiento de mensajes en el centro de IoT (por clave).	Principal	GA
az iot hub message-route	Administre rutas de una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route create	Agregue una ruta para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route delete	Elimine todas las rutas o una ruta mencionada en una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route fallback	Administre la ruta de reserva de un centro de IoT.	Extensión	Vista previa
az iot hub message-route fallback set	Habilite o deshabilite la ruta de reserva en una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route fallback show	Mostrar la ruta de reserva de una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route list	Obtenga todas las rutas de una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route show	Obtenga información sobre la ruta en una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route test	Pruebe todas las rutas o una ruta mencionada en una instancia de IoT Hub.	Extensión	Vista previa
az iot hub message-route update	Actualice una ruta para una instancia de IoT Hub.	Extensión	Vista previa
az iot hub module-identity	Administre módulos de dispositivo IoT.	Extensión	GA
az iot hub module-identity connection-string	Administre la cadena de conexión del módulo de dispositivo IoT.	Extensión	GA
az iot hub module-identity connection-string show	Mostrar un cadena de conexión del módulo de dispositivo IoT de destino.	Extensión	GA
az iot hub module-identity create	Cree un módulo en un dispositivo IoT de destino en una instancia de IoT Hub.	Extensión	GA
az iot hub module-identity delete	Elimine un dispositivo en una instancia de IoT Hub.	Extensión	GA
az iot hub module-identity list	Enumere los módulos ubicados en un dispositivo IoT en una instancia de IoT Hub.	Extensión	GA
az iot hub module-identity renew-key	Renueve las claves de destino de un módulo de dispositivo de IoT Hub con autenticación sas.	Extensión	GA
az iot hub module-identity show	Obtenga los detalles de un módulo de dispositivo IoT en una instancia de IoT Hub.	Extensión	GA
az iot hub module-identity update	Actualice un módulo de dispositivo de IoT Hub.	Extensión	GA
az iot hub module-twin	Administre la configuración de módulos gemelos de dispositivos IoT.	Extensión	GA
az iot hub module-twin replace	Reemplace una definición de módulo gemelo por json de destino.	Extensión	GA
az iot hub module-twin show	Mostrar una definición de módulo gemelo.	Extensión	GA
az iot hub module-twin update	Actualice las propiedades y etiquetas deseadas del módulo gemelo.	Extensión	GA
az iot hub monitor-events	Supervise los mensajes y telemetría del dispositivo enviados a ioT Hub.	Extensión	GA
az iot hub monitor-feedback	Supervise los comentarios enviados por los dispositivos para confirmar los mensajes de la nube al dispositivo (C2D).	Extensión	GA
az iot hub policy	Administre directivas de acceso compartido de una instancia de IoT Hub.	Principal	GA
az iot hub policy create	Cree una nueva directiva de acceso compartido en un centro de IoT.	Principal	GA
az iot hub policy delete	Elimine una directiva de acceso compartido de un centro de IoT.	Principal	GA
az iot hub policy list	Enumerar las directivas de acceso compartido de un centro de IoT.	Principal	GA
az iot hub policy renew-key	Regenera las claves de una directiva de acceso compartido de un centro de IoT.	Principal	GA
az iot hub policy show	Obtenga los detalles de una directiva de acceso compartido de un centro de IoT.	Principal	GA
az iot hub query	Consulte una instancia de IoT Hub mediante un lenguaje eficaz similar a SQL.	Extensión	GA
az iot hub route	Administre rutas de una instancia de IoT Hub.	Principal	En desuso
az iot hub route create	Cree una ruta en IoT Hub.	Principal	En desuso
az iot hub route delete	Elimine todas las rutas o mencionadas para IoT Hub.	Principal	En desuso
az iot hub route list	Obtenga todas las rutas de IoT Hub.	Principal	En desuso
az iot hub route show	Obtenga información sobre la ruta en IoT Hub.	Principal	En desuso
az iot hub route test	Pruebe todas las rutas o la ruta mencionada en IoT Hub.	Principal	En desuso
az iot hub route update	Actualice una ruta en IoT Hub.	Principal	En desuso
az iot hub routing-endpoint	Administre puntos de conexión personalizados de una instancia de IoT Hub.	Principal	En desuso
az iot hub routing-endpoint create	Agregue un punto de conexión a IoT Hub.	Principal	En desuso
az iot hub routing-endpoint delete	Elimine todo el punto de conexión o mencionado para ioT Hub.	Principal	En desuso
az iot hub routing-endpoint list	Obtenga información sobre todos los puntos de conexión de IoT Hub.	Principal	En desuso
az iot hub routing-endpoint show	Obtenga información sobre el punto de conexión mencionado para ioT Hub.	Principal	En desuso
az iot hub show	Obtenga los detalles de un centro de IoT.	Principal	GA
az iot hub show-connection-string	Mostrar los cadena de conexión de un centro de IoT.	Principal	En desuso
az iot hub show-quota-metrics	Obtenga las métricas de cuota de un centro de IoT.	Principal	GA
az iot hub show-stats	Obtenga las estadísticas de un centro de IoT.	Principal	GA
az iot hub state	Administre el estado de una instancia de IoT Hub.	Extensión	Habilitación de características
az iot hub state export	Exporte el estado de una instancia de IoT Hub a un archivo.	Extensión	Habilitación de características
az iot hub state import	Importe un estado del centro de conectividad de un archivo a una instancia de IoT Hub.	Extensión	Habilitación de características
az iot hub state migrate	Migre el estado de un centro a otro sin guardarlo en un archivo.	Extensión	Habilitación de características
az iot hub update	Actualice los metadatos de un centro de IoT.	Principal	GA
az iot hub wait	Espere hasta que se complete una operación en una instancia de IoT Hub.	Principal	GA

az iot hub create

Editar

Cree una instancia de Azure IoT Hub.

Para obtener una introducción a Azure IoT Hub, consulte https://docs.microsoft.com/azure/iot-hub/.

az iot hub create --name
                  --resource-group
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--edr {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--location]
                  [--mi-system-assigned {false, true}]
                  [--mi-user-assigned]
                  [--min-tls-version]
                  [--no-wait]
                  [--partition-count]
                  [--rd]
                  [--role]
                  [--scopes]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--tags]
                  [--unit]

Ejemplos

Cree una instancia de IoT Hub con el plan de tarifa gratuito F1, en la región del grupo de recursos.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --sku F1 --partition-count 2

Cree una instancia de IoT Hub con el plan de tarifa estándar S1 y 4 particiones, en la región "westus", con etiquetas.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --tags a=b c=d

Cree una instancia de IoT Hub con una identidad administrada asignada por el sistema y asigne un rol y un ámbito a una cuenta de almacenamiento para la identidad creada.

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --mi-system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

Creación de una instancia de IoT Hub con autenticación local, claves SAS de dispositivo y claves SAS del módulo todas deshabilitadas

az iot hub create --resource-group MyResourceGroup --name MyIotHub --location westus --disable-local-auth --disable-device-sas --disable-module-sas

Cree una instancia de IoT Hub con la residencia de datos aplicada. Esto deshabilitará la recuperación ante desastres entre regiones.

az iot hub create --resource-group MyResourceGroup --name MyIoTHub --edr

Parámetros requeridos

--name -n

Nombre de IoT Hub.

--resource-group -g

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

Parámetros opcionales

--c2d-max-delivery-count --cdd

El número de veces que el centro de IoT intentará entregar un mensaje de nube a dispositivo a un dispositivo, entre 1 y 100.

Valor predeterminado: 10

--c2d-ttl --ct

La cantidad de tiempo que un mensaje está disponible para que el dispositivo lo consuma antes de que IoT Hub expire, entre 1 y 48 horas.

Valor predeterminado: 1

--dds --disable-device-sas

Valor booleano que indica si se deben deshabilitar o no todos los dispositivos (incluidos los dispositivos perimetrales, pero los módulos excluidos) claves SAS con ámbito para la autenticación.

Valores aceptados: false, true

--disable-local-auth --dla

Valor booleano que indica si se deben deshabilitar o no claves SAS con ámbito de IoT Hub para la autenticación.

Valores aceptados: false, true

--disable-module-sas --dms

Valor booleano que indica si se deben deshabilitar o no claves SAS con ámbito de módulo para la autenticación.

Valores aceptados: false, true

--edr --enforce-data-residency

Aplique la residencia de datos para esta instancia de IoT Hub deshabilitando la recuperación ante desastres entre regiones. Esta propiedad es inmutable una vez establecida en el recurso. Solo está disponible en regiones seleccionadas. Obtenga más información en https://aka.ms/iothubdisabledr.

Valores aceptados: false, true

--fc --fileupload-storage-container-name

Nombre del contenedor raíz donde se cargan los archivos. El contenedor no debe existir, pero debe ser creatable mediante el parámetro connectionString especificado.

--fcs --fileupload-storage-connectionstring

El cadena de conexión de la cuenta de Azure Storage a la que se cargan los archivos.

--fd --feedback-max-delivery-count

Número de veces que el centro de IoT intenta entregar un mensaje en la cola de comentarios, entre 1 y 100.

Valor predeterminado: 10

--feedback-lock-duration --fld

Duración del bloqueo de la cola de comentarios, entre 5 y 300 segundos.

Valor predeterminado: 5

--feedback-ttl --ft

Período de tiempo durante el cual el centro de IoT mantendrá los comentarios para la expiración o entrega de mensajes de nube a dispositivo, entre 1 y 48 horas.

Valor predeterminado: 1

--fileupload-notification-lock-duration --fnld

Duración del bloqueo de la cola de notificaciones de carga de archivos, entre 5 y 300 segundos.

Valor predeterminado: 5

--fileupload-notification-max-delivery-count --fnd

Número de veces que el centro de IoT intentará entregar un mensaje de notificación de archivo, entre 1 y 100.

Valor predeterminado: 10

--fileupload-notification-ttl --fnt

La cantidad de tiempo que una notificación de carga de archivos está disponible para que el servicio lo consuma antes de que IoT Hub expire, entre 1 y 48 horas.

Valor predeterminado: 1

--fileupload-notifications --fn

Valor booleano que indica si se va a registrar información sobre los archivos cargados en el punto de conexión de IoT Hub messages/servicebound/filenotifications.

Valores aceptados: false, true

Valor predeterminado: False

--fileupload-sas-ttl --fst

La cantidad de tiempo que un URI de SAS generado por IoT Hub es válido antes de que expire, entre 1 y 24 horas.

Valor predeterminado: 1

--fileupload-storage-auth-type --fsa

Tipo de autenticación de la cuenta de Azure Storage a la que se cargan los archivos.

Valores aceptados: identityBased, keyBased

--fileupload-storage-identity --fsi

Identidad administrada que se va a usar para la autenticación de carga de archivos. Use "[system]" para hacer referencia a la identidad administrada asignada por el sistema o a un identificador de recurso para hacer referencia a una identidad administrada asignada por el usuario.

--location -l

Ubicación de ioT Hub. El valor predeterminado es la ubicación del grupo de recursos de destino.

--mi-system-assigned

Habilite la identidad administrada asignada por el sistema para este centro.

Valores aceptados: false, true

--mi-user-assigned

Habilite las identidades administradas asignadas por el usuario para este centro. Acepte la lista separada por espacios de identificadores de recursos de identidad.

--min-tls-version --mintls

Especifique la versión mínima de TLS que se va a admitir para este centro. Se puede establecer en "1.2" para que los clientes que usen una versión tls inferior a la 1.2 se rechacen.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False

--partition-count

Número de particiones del centro de eventos de respaldo para mensajes de dispositivo a nube.

Valor predeterminado: 4

--rd --retention-day

Especifica cuánto tiempo mantendrá este centro de IoT eventos de dispositivo a nube, entre 1 y 7 días.

Valor predeterminado: 1

--role

Rol que se va a asignar a la identidad administrada asignada por el sistema del centro.

--scopes

Lista separada por espacios de ámbitos para asignar el rol (--role) a la identidad administrada asignada por el sistema.

--sku

Plan de tarifa para Azure IoT Hub. Tenga en cuenta que solo se permite una instancia gratuita de IoT Hub (F1) en cada suscripción. Se producirá una excepción si las instancias libres superan una.

Valores aceptados: B1, B2, B3, F1, S1, S2, S3

Valor predeterminado: S1

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--unit

Unidades en ioT Hub.

Valor predeterminado: 1

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 hub delete

Editar

Elimine un centro de IoT.

az iot hub delete [--ids]
                  [--name]
                  [--no-wait]
                  [--resource-group]
                  [--subscription]

Ejemplos

Elimine un centro de IoT. (generado automáticamente)

az iot hub delete --name MyIoTHub --resource-group MyResourceGroup

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name -n

Nombre de IoT Hub.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False

--resource-group -g

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

--subscription

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

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 hub generate-sas-token

Genere un token de SAS para un ioT Hub de destino, un dispositivo o un módulo.

En el caso de los tokens saS de dispositivo, el parámetro de directiva solo se usa para acceder al registro de dispositivos. Por lo tanto, la directiva debe tener acceso de lectura al Registro. Para los tokens de IoT Hub, la directiva forma parte de la SAS.

az iot hub generate-sas-token [--auth-type {key, login}]
                              [--connection-string]
                              [--device-id]
                              [--du]
                              [--hub-name]
                              [--key-type {primary, secondary}]
                              [--login]
                              [--module-id]
                              [--pn]
                              [--resource-group]

Ejemplos

Genere un token de SAS de IoT Hub mediante la directiva iothubowner y la clave principal.

az iot hub generate-sas-token -n {iothub_name}

Genere un token de SAS de IoT Hub mediante la directiva RegistryRead y la clave secundaria.

az iot hub generate-sas-token -n {iothub_name} --policy registryRead --key-type secondary

Genere un token de SAS de dispositivo mediante la directiva iothubowner para acceder al registro de dispositivos {iothub_name}.

az iot hub generate-sas-token -d {device_id} -n {iothub_name}

Generación de un token de SAS de dispositivo mediante una cadena de conexión de IoT Hub (con acceso al registro)

az iot hub generate-sas-token -d {device_id} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Generación de un token de SAS de IoT Hub mediante una cadena de conexión de IoT Hub

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Generación de un token de SAS de dispositivo mediante un dispositivo cadena de conexión

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Generación de un token saS de módulo mediante un módulo cadena de conexión

az iot hub generate-sas-token --connection-string 'HostName=myhub.azure-devices.net;DeviceId=mydevice;ModuleId=mymodule;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

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

--connection-string --cs

Cadena de conexión de destino. Esto omite el registro de IoT Hub y genera el token de SAS directamente desde la clave simétrica proporcionada sin ninguna validación adicional. Se omitirán todos los demás parámetros de comando aparte de la duración. Tipos de cadena de conexión admitidos: Iot Hub, Device, Module.

--device-id -d

Id. de dispositivo de destino.

--du --duration

Duración válida del token en segundos.

Valor predeterminado: 3600

--hub-name -n

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

--key-type --kt

Tipo de clave de directiva de acceso compartido para la autenticación.

Valores aceptados: primary, secondary

Valor predeterminado: primary

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

--module-id -m

Id. del módulo de destino.

--pn --policy-name

Directiva de acceso compartido con permisos de operación para la entidad de IoT Hub de destino.

Valor predeterminado: iothubowner

--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 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 hub invoke-device-method

Invoque un método de dispositivo.

az iot hub invoke-device-method --device-id
                                --method-name
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Ejemplos

Invoque un método directo en un dispositivo.

az iot hub invoke-device-method --hub-name {iothub_name} --device-id {device_id} --method-name Reboot --method-payload '{"version":"1.0"}'

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

--method-name --mn

Método de destino para la invocación.

Parámetros opcionales

--auth-type

Valores aceptados: key, login

Valor predeterminado: key

--hub-name -n

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

--login -l

--method-payload --mp

Carga json que se va a pasar al método . Debe ser la ruta de acceso del archivo o json sin formato.

Valor predeterminado: {}

--resource-group -g

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

--timeout --to

Número máximo de segundos para esperar el resultado del método de dispositivo.

Valor predeterminado: 30

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 hub invoke-module-method

Invoque un método de módulo.

Este comando admite módulos de dispositivos perimetrales y no perimetrales.

az iot hub invoke-module-method --device-id
                                --method-name
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--method-payload]
                                [--resource-group]
                                [--timeout]

Ejemplos

Invoque un método directo en un módulo de dispositivo perimetral.

az iot hub invoke-module-method -n {iothub_name} -d {device_id} -m '$edgeAgent' --method-name 'RestartModule' --method-payload '{"schemaVersion": "1.0"}'

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

--method-name --mn

Método de destino para la invocación.

--module-id -m

Id. del módulo de destino.

Parámetros opcionales

--auth-type

Valores aceptados: key, login

Valor predeterminado: key

--hub-name -n

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

--login -l

--method-payload --mp

Carga json que se va a pasar al método . Debe ser la ruta de acceso del archivo o json sin formato.

Valor predeterminado: {}

--resource-group -g

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

--timeout --to

Número máximo de segundos para esperar el resultado del método de módulo.

Valor predeterminado: 30

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 hub list

Editar

Enumeración de centros de IoT.

az iot hub list [--resource-group]

Ejemplos

Enumere todos los centros de IoT de una suscripción.

az iot hub list

Enumeración de todos los centros de IoT del grupo de recursos "MyGroup"

az iot hub list --resource-group MyGroup

Parámetros opcionales

--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 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 hub list-skus

Editar

Enumere los planes de tarifa disponibles.

az iot hub list-skus [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Ejemplos

Enumere los planes de tarifa disponibles. (generado automáticamente)

az iot hub list-skus --name MyIoTHub

Parámetros opcionales

--ids

--name -n

Nombre de IoT Hub.

--resource-group -g

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

--subscription

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

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 hub manual-failover

Editar

Inicie una conmutación por error manual para IoT Hub a la región de recuperación ante desastres emparejada geográficamente.

az iot hub manual-failover [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]

Ejemplos

Inicie la conmutación por error "myhub" desde la región principal a la secundaria.

az iot hub manual-failover -n myhub

Parámetros opcionales

--ids

--name -n

Nombre de IoT Hub.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False

--resource-group -g

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

--subscription

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

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 hub monitor-events

Supervise los mensajes y telemetría del dispositivo enviados a ioT Hub.

Este comando se basa en y puede instalar el paquete Cython dependiente (uamqp) tras la primera ejecución. https://github.com/Azure/azure-uamqp-python

Nota: El evento se mostrará incluso si el cuerpo del mensaje no es descodificador unicode, en este caso, la parte de carga del evento se mostrará como {{carga no descodable}} con el resto de las propiedades del evento disponibles.

az iot hub monitor-events [--cg]
                          [--content-type]
                          [--device-id]
                          [--device-query]
                          [--enqueued-time]
                          [--hub-name]
                          [--interface]
                          [--login]
                          [--mc]
                          [--module-id]
                          [--properties {all, anno, app, sys}]
                          [--repair {false, true}]
                          [--resource-group]
                          [--timeout]
                          [--yes {false, true}]

Ejemplos

Uso básico

az iot hub monitor-events -n {iothub_name}

Uso básico con una cadena de conexión de IoT Hub

az iot hub monitor-events -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Uso básico al filtrar en el dispositivo de destino

az iot hub monitor-events -n {iothub_name} -d {device_id}

Uso básico al filtrar dispositivos de destino con un carácter comodín en el identificador

az iot hub monitor-events -n {iothub_name} -d Device*

Filtrado de dispositivos mediante el lenguaje de consulta de IoT Hub

az iot hub monitor-events -n {iothub_name} -q "select * from devices where tags.location.region = 'US'"

Filtre el dispositivo y especifique un grupo de consumidores del centro de eventos al que se va a enlazar.

az iot hub monitor-events -n {iothub_name} -d {device_id} --cg {consumer_group_name}

Recibir anotaciones de mensaje (encabezados de mensaje)

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno

Recibir anotaciones de mensaje + propiedades del sistema. Nunca agote el tiempo de espera.

az iot hub monitor-events -n {iothub_name} -d {device_id} --properties anno sys --timeout 0

Recepción de todos los atributos de mensaje de todos los mensajes de dispositivo

az iot hub monitor-events -n {iothub_name} --props all

Recepción de todos los mensajes y análisis de la carga de mensajes como JSON

az iot hub monitor-events -n {iothub_name} --content-type application/json

Reciba el número especificado de mensajes del centro y, a continuación, se apague.

az iot hub monitor-events -n {iothub_name} --message-count {message_count}

Parámetros opcionales

--cg --consumer-group -c

Especifique el grupo de consumidores que se usará al conectarse al punto de conexión del centro de eventos.

Valor predeterminado: $Default

--content-type --ct

Especifique el tipo de contenido de la carga del mensaje para dar formato automáticamente a la salida a ese tipo.

--device-id -d

Id. de dispositivo de destino.

--device-query -q

Especifique una consulta personalizada para filtrar los dispositivos.

--enqueued-time --et -e

Indica la hora que se debe usar como punto de partida para leer los mensajes de las particiones. Las unidades son milisegundos desde la época unix. Si no se indica "ahora" se usa ninguna hora.

--hub-name -n

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

--interface -i

Identificador de interfaz de destino en el que se va a filtrar. Por ejemplo: dtmi:com:example:TemperatureController;1.

--login -l

--mc --message-count

Número de mensajes de telemetría que se van a capturar antes de que finalice el monitor. Si no se especifica, el monitor sigue ejecutándose hasta que se cumpla el umbral de tiempo de espera de no recibir mensajes del centro.

--module-id -m

Id. del módulo de destino.

--properties --props -p

Indique las propiedades del mensaje clave que se van a generar. sys = propiedades del sistema, app = propiedades de la aplicación, anno = anotaciones.

Valores aceptados: all, anno, app, sys

--repair -r

Vuelva a instalar la dependencia de uamqp compatible con la versión de la extensión. Valor predeterminado: false.

Valores aceptados: false, true

Valor predeterminado: False

--resource-group -g

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

--timeout --to -t

Máximo de segundos para mantener la conexión sin recibir el mensaje. Use 0 para infinito.

Valor predeterminado: 300

--yes -y

Omita las indicaciones del usuario. Indica la aceptación de la acción. Se usa principalmente para escenarios de automatización. Valor predeterminado: false.

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.

az iot hub monitor-feedback

Supervise los comentarios enviados por los dispositivos para confirmar los mensajes de la nube al dispositivo (C2D).

Este comando se basa en y puede instalar el paquete Cython dependiente (uamqp) tras la primera ejecución. https://github.com/Azure/azure-uamqp-python.

az iot hub monitor-feedback [--auth-type {key, login}]
                            [--device-id]
                            [--hub-name]
                            [--login]
                            [--repair {false, true}]
                            [--resource-group]
                            [--wait-on-msg]
                            [--yes {false, true}]

Ejemplos

Uso básico

az iot hub monitor-feedback -n {iothub_name}

Uso básico con una cadena de conexión de IoT Hub

az iot hub monitor-feedback -n {iothub_name} --login 'HostName=myhub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=12345'

Uso básico al filtrar en el dispositivo de destino

az iot hub monitor-feedback -n {iothub_name} -d {device_id}

Supervisión de comentarios de salida al recibir un mensaje con un identificador específico (uuid)

az iot hub monitor-feedback -n {iothub_name} -d {device_id} -w {message_id}

Parámetros opcionales

--auth-type

Valores aceptados: key, login

Valor predeterminado: key

--device-id -d

Id. de dispositivo de destino.

--hub-name -n

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

--login -l

--repair -r

Vuelva a instalar la dependencia de uamqp compatible con la versión de la extensión. Valor predeterminado: false.

Valores aceptados: false, true

Valor predeterminado: False

--resource-group -g

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

--wait-on-msg -w

El monitor de comentarios se bloqueará hasta que se reciba un mensaje con un identificador específico (uuid).

--yes -y

Omita las indicaciones del usuario. Indica la aceptación de la acción. Se usa principalmente para escenarios de automatización. Valor predeterminado: false.

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.

az iot hub query

Consulte una instancia de IoT Hub mediante un lenguaje eficaz similar a SQL.

Recupere información sobre dispositivos y módulos gemelos, trabajos y enrutamiento de mensajes. Vea https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language para más información.

az iot hub query --query-command
                 [--auth-type {key, login}]
                 [--hub-name]
                 [--login]
                 [--resource-group]
                 [--top]

Ejemplos

Consulte todos los datos de dispositivos gemelos en una instancia de Azure IoT Hub.

az iot hub query -n {iothub_name} -q "select * from devices"

Consulte todos los datos del módulo gemelo en el dispositivo de destino.

az iot hub query -n {iothub_name} -q "select * from devices.modules where devices.deviceId = '{device_id}'"

Parámetros requeridos

--query-command -q

Consulta de usuario que se va a ejecutar.

Parámetros opcionales

--auth-type

Valores aceptados: key, login

Valor predeterminado: key

--hub-name -n

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

--login -l

--resource-group -g

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

--top

Número máximo de elementos que se van a devolver. De forma predeterminada, la consulta no tiene ningún límite.

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 hub show

Editar

Obtenga los detalles de un centro de IoT.

az iot hub show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

Ejemplos

Obtenga los detalles de un centro de IoT. (generado automáticamente)

az iot hub show --name MyIoTHub

Parámetros opcionales

--ids

--name -n

Nombre de IoT Hub.

--resource-group -g

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

--subscription

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

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 hub show-connection-string

Editar

Obsoleto

Este comando ha quedado en desuso y se quitará en una versión futura. En su lugar, use el comando "IoT Extension (azure-iot) connection-string string show(az iot hub connection-string show)".

Mostrar los cadena de conexión de un centro de IoT.

az iot hub show-connection-string [--all]
                                  [--hub-name]
                                  [--ids]
                                  [--key {primary, secondary}]
                                  [--policy-name]
                                  [--resource-group]
                                  [--subscription]

Ejemplos

Muestre la cadena de conexión de un centro de IoT mediante la directiva predeterminada y la clave principal.

az iot hub show-connection-string --name MyIotHub

Muestre la cadena de conexión de una instancia de IoT Hub mediante la directiva "servicio" y la clave secundaria.

az iot hub show-connection-string --name MyIotHub --policy-name service --key secondary

Muestre los cadena de conexión para todos los centros de IoT de un grupo de recursos.

az iot hub show-connection-string --resource-group MyResourceGroup

Muestre los cadena de conexión para todos los centros de IoT de una suscripción.

az iot hub show-connection-string

Mostrar los cadena de conexión de un centro de IoT. (generado automáticamente)

az iot hub show-connection-string --key primary --policy-name MyPolicy

Parámetros opcionales

--all

Permitir mostrar todas las directivas de acceso compartido.

Valor predeterminado: False

--hub-name --name -n

Nombre de IoT Hub.

--ids

--key

Clave que se va a usar.

Valores aceptados: primary, secondary

Valor predeterminado: primary

--policy-name

Directiva de acceso compartido que se va a usar.

Valor predeterminado: iothubowner

--resource-group -g

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

--subscription

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

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 hub show-quota-metrics

Editar

Obtenga las métricas de cuota de un centro de IoT.

az iot hub show-quota-metrics [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Ejemplos

Obtenga las métricas de cuota de un centro de IoT. (generado automáticamente)

az iot hub show-quota-metrics --ids {ids}

Obtenga las métricas de cuota de un centro de IoT. (generado automáticamente)

az iot hub show-quota-metrics --name MyIoTHub

Parámetros opcionales

--ids

--name -n

Nombre de IoT Hub.

--resource-group -g

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

--subscription

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

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 hub show-stats

Editar

Obtenga las estadísticas de un centro de IoT.

az iot hub show-stats [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Ejemplos

Obtenga las estadísticas de un centro de IoT. (generado automáticamente)

az iot hub show-stats --name MyIoTHub

Parámetros opcionales

--ids

--name -n

Nombre de IoT Hub.

--resource-group -g

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

--subscription

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

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 hub update

Editar

Actualice los metadatos de un centro de IoT.

az iot hub update [--add]
                  [--c2d-max-delivery-count]
                  [--c2d-ttl]
                  [--dds {false, true}]
                  [--disable-local-auth {false, true}]
                  [--disable-module-sas {false, true}]
                  [--fc]
                  [--fcs]
                  [--fd]
                  [--feedback-lock-duration]
                  [--feedback-ttl]
                  [--fileupload-notification-lock-duration]
                  [--fileupload-notification-max-delivery-count]
                  [--fileupload-notification-ttl]
                  [--fileupload-notifications {false, true}]
                  [--fileupload-sas-ttl]
                  [--fileupload-storage-auth-type {identityBased, keyBased}]
                  [--fileupload-storage-identity]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--rd]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--sku {B1, B2, B3, F1, S1, S2, S3}]
                  [--subscription]
                  [--tags]
                  [--unit]

Ejemplos

Adición de la configuración del contenedor de almacenamiento a la carga de archivos

az iot hub update --name MyIotHub --fileupload-storage-connectionstring "connection-string" \ --fileupload-storage-container-name "container_name"

Agregue una regla de filtro de firewall para aceptar el tráfico de la máscara IP 127.0.0.0/31.

az iot hub update --name MyIotHub --add properties.ipFilterRules filter_name=test-rule action=Accept ip_mask=127.0.0.0/31

Actualice los metadatos de un centro de IoT. (generado automáticamente)

az iot hub update --name MyIotHub --set properties.allocationPolicy="GeoLatency"

Actualice las unidades de una instancia de IoT Hub a 2 y agregue etiquetas

az iot hub update -n MyIotHub --unit 2 --tags a=b c=d

Actualización del plan de tarifa de una instancia de IoT Hub como S2

az iot hub update -n MyIotHub --sku S2

Actualizar los días de retención de eventos de dispositivo a nube de IoT Hub como 3 días

az iot hub update -n MyIotHub --retention-day 3

Actualización de la configuración de mensajería de nube a dispositivo de IoT Hub

az iot hub update --name MyIotHub --c2d-max-delivery-count 30 --c2d-ttl 5

Actualización de la configuración de cola de comentarios de IoT Hub

az iot hub update --name MyIoTHub --feedback-max-delivery-count 20 --feedback-lock-duration 100 --feedback-ttl 4

Actualice la configuración de carga de archivos de IoT Hub y asigne una identidad administrada al usuario para la carga de archivos.

az iot hub update -n MyIoTHub --fileupload-sas-ttl 5 --fileupload-storage-auth-type identityBased --fileupload-storage-identity [system]

Actualizar la configuración de notificación de carga de archivos de IoT Hub y la duración del bloqueo de cola

az iot hub update -n MyIoTHub --fileupload-notification-max-delivery-count 50 --fileupload-notification-ttl 48 --fileupload-notifications --fileupload-notification-lock-duration 10

Actualización de la autenticación local de IoT Hub, la SAS del dispositivo y la configuración de SAS del módulo

az iot hub update -n MyIoTHub --disable-local-auth --disable-device-sas false --disable-module-sas true

Parámetros opcionales

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Valor predeterminado: []

--c2d-max-delivery-count --cdd

El número de veces que el centro de IoT intentará entregar un mensaje de nube a dispositivo a un dispositivo, entre 1 y 100.

--c2d-ttl --ct

La cantidad de tiempo que un mensaje está disponible para que el dispositivo lo consuma antes de que IoT Hub expire, entre 1 y 48 horas.

--dds --disable-device-sas

Valor booleano que indica si se deben deshabilitar o no todos los dispositivos (incluidos los dispositivos perimetrales, pero los módulos excluidos) claves SAS con ámbito para la autenticación.

Valores aceptados: false, true

--disable-local-auth --dla

Valor booleano que indica si se deben deshabilitar o no claves SAS con ámbito de IoT Hub para la autenticación.

Valores aceptados: false, true

--disable-module-sas --dms

Valor booleano que indica si se deben deshabilitar o no claves SAS con ámbito de módulo para la autenticación.

Valores aceptados: false, true

--fc --fileupload-storage-container-name

Nombre del contenedor raíz donde se cargan los archivos. El contenedor no debe existir, pero debe ser creatable mediante el parámetro connectionString especificado.

--fcs --fileupload-storage-connectionstring

El cadena de conexión de la cuenta de Azure Storage a la que se cargan los archivos.

--fd --feedback-max-delivery-count

Número de veces que el centro de IoT intenta entregar un mensaje en la cola de comentarios, entre 1 y 100.

--feedback-lock-duration --fld

Duración del bloqueo de la cola de comentarios, entre 5 y 300 segundos.

--feedback-ttl --ft

Período de tiempo durante el cual el centro de IoT mantendrá los comentarios para la expiración o entrega de mensajes de nube a dispositivo, entre 1 y 48 horas.

--fileupload-notification-lock-duration --fnld

Duración del bloqueo de la cola de notificaciones de carga de archivos, entre 5 y 300 segundos.

--fileupload-notification-max-delivery-count --fnd

Número de veces que el centro de IoT intentará entregar un mensaje de notificación de archivo, entre 1 y 100.

--fileupload-notification-ttl --fnt

La cantidad de tiempo que una notificación de carga de archivos está disponible para que el servicio lo consuma antes de que IoT Hub expire, entre 1 y 48 horas.

--fileupload-notifications --fn

Valor booleano que indica si se va a registrar información sobre los archivos cargados en el punto de conexión de IoT Hub messages/servicebound/filenotifications.

Valores aceptados: false, true

--fileupload-sas-ttl --fst

La cantidad de tiempo que un URI de SAS generado por IoT Hub es válido antes de que expire, entre 1 y 24 horas.

--fileupload-storage-auth-type --fsa

Tipo de autenticación de la cuenta de Azure Storage a la que se cargan los archivos.

Valores aceptados: identityBased, keyBased

--fileupload-storage-identity --fsi

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Valor predeterminado: False

--ids

--name -n

Nombre de IoT Hub.

--rd --retention-day

Especifica cuánto tiempo mantendrá este centro de IoT eventos de dispositivo a nube, entre 1 y 7 días.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Valor predeterminado: []

--resource-group -g

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

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Valor predeterminado: []

--sku

Plan de tarifa para Azure IoT Hub. Tenga en cuenta que solo se permite una instancia gratuita de IoT Hub (F1) en cada suscripción. Se producirá una excepción si las instancias libres superan una.

Valores aceptados: B1, B2, B3, F1, S1, S2, S3

--subscription

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

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--unit

Unidades en ioT Hub.

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 hub wait

Editar

Espere hasta que se complete una operación en una instancia de IoT Hub.

az iot hub wait [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--ids]
                [--interval]
                [--name]
                [--resource-group]
                [--subscription]
                [--timeout]
                [--updated]

Ejemplos

Espere hasta que se cree una instancia de IoT Hub existente

az iot hub wait -n MyIoTHub --created

Espere hasta que se elimine una instancia de IoT Hub.

az iot hub wait -n MyIoTHub --deleted

Espere hasta que una instancia de IoT Hub existente tenga un estado activo

az iot hub wait -n MyIoTHub --custom "properties.state=='Active'"

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Valor predeterminado: False

--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

Valor predeterminado: False

--exists

Espere hasta que exista el recurso.

Valor predeterminado: False

--ids

--interval

Intervalo de sondeo en segundos.

Valor predeterminado: 30

--name -n

Nombre de IoT Hub.

--resource-group -g

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

--subscription

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

--timeout

Espera máxima en segundos.

Valor predeterminado: 3600

--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

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.

Compartir a través de

az iot hub

Comandos

az iot hub create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az iot hub delete

Ejemplos

Parámetros opcionales

az iot hub generate-sas-token

Ejemplos

Parámetros opcionales

az iot hub invoke-device-method

Ejemplos

Parámetros requeridos

Parámetros opcionales

az iot hub invoke-module-method

Ejemplos

Parámetros requeridos

Parámetros opcionales

az iot hub list

Ejemplos

Parámetros opcionales

az iot hub list-skus

Ejemplos

Parámetros opcionales

az iot hub manual-failover

Ejemplos

Parámetros opcionales

az iot hub monitor-events

Ejemplos

Parámetros opcionales

az iot hub monitor-feedback

Ejemplos

Parámetros opcionales

az iot hub query

Ejemplos

Parámetros requeridos

Parámetros opcionales

az iot hub show

Ejemplos

Parámetros opcionales

az iot hub show-connection-string

Ejemplos

Parámetros opcionales

az iot hub show-quota-metrics

Ejemplos

Parámetros opcionales

az iot hub show-stats

Ejemplos

Parámetros opcionales

az iot hub update

Ejemplos

Parámetros opcionales

az iot hub wait

Ejemplos

Parámetros opcionales

Recursos adicionales