Compartir a través de

az iot hub configuration

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 se instalará automáticamente la primera vez que ejecute un comando az iot hub configuration. Obtenga más información sobre las extensiones.

Administración de la configuración de administración automática a escala de dispositivos IoT.

Comandos

Nombre Description Tipo Estado
az iot hub configuration create

Cree una configuración de administración automática de dispositivos IoT en un centro de IoT de destino.

 Extension GA
az iot hub configuration delete

Elimine una configuración de dispositivo IoT.

 Extension GA
az iot hub configuration list

Enumere las configuraciones de administración automática de dispositivos de IoT en una instancia de IoT Hub.

 Extension GA
az iot hub configuration show

Obtenga los detalles de una configuración de administración automática de dispositivos IoT.

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

 Extension GA
az iot hub configuration update

Actualice las propiedades especificadas de una configuración de administración automática de dispositivos IoT.

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

El contenido de configuración es json y ligeramente varía en función de la intención del dispositivo o del módulo.

Las configuraciones de dispositivo están en forma de {"deviceContent":{...}} o {"content":{"deviceContent":{...}}}

Las configuraciones de módulo están en forma de {"moduleContent":{...}} o {"content":{"moduleContent":{...}}}

Las configuraciones se pueden definir con métricas proporcionadas por el usuario para la evaluación a petición. Las métricas de usuario son json y en forma de {"queries":{...}} o {"metrics":{"queries":{...}}}.

Nota: La condición de destino de los módulos debe comenzar con "from devices.modules where".

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl --custom-labels]
                                [--cmq --custom-metric-queries]
                                [--hub-name]
                                [--lab --labels]
                                [--login]
                                [--metrics]
                                [--pri --priority]
                                [--resource-group]
                                [--target-condition --tc]

Ejemplos

Cree una configuración de dispositivo con una prioridad de 3 que se aplique a condición cuando un dispositivo se etiquete en la compilación 9 y el entorno sea "test".

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Cree una configuración de dispositivo con etiquetas y proporcione métricas de usuario insertadas (ejemplo de sintaxis de Bash).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Crear una configuración de módulo con etiquetas y proporcionar métricas de usuario insertadas (ejemplo de sintaxis cmd)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Cree una configuración de módulo con contenido y métricas de usuario insertadas (ejemplo de sintaxis de PowerShell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Cree una configuración de dispositivo con un estilo de entrada alternativo de etiquetas y métricas (independiente del shell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parámetros requeridos

--config-id -c

Nombre de configuración del dispositivo de destino. Se permiten minúsculas y los siguientes caracteres especiales: [-+%_*!'].

--content -k

Contenido de configuración del dispositivo. Proporcione la ruta de acceso del archivo o json sin formato.

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
--cl --custom-labels

Un estilo de entrada alternativo (pares clave=valor separados por espacios) para --labels y diseñado para reemplazarlo en el futuro. Ejemplo de formato: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Un estilo de entrada alternativo (pares clave=valor separados por espacios) para --metrics y diseñado para reemplazarlo en el futuro. Ejemplo de formato: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--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
--lab --labels

Asignación de etiquetas que se aplicarán a la configuración de destino. Se recomienda usar --custom-labels en lugar de --labels. Ejemplo de formato: {"key0":"value0", "key1":"value1"}.

--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
--metrics -m

Definiciones de métricas de configuración del dispositivo. Proporcione la ruta de acceso del archivo o json sin formato. Se recomienda usar --custom-metric-queries en lugar de --metrics.

--pri --priority

Peso de la configuración del dispositivo en caso de reglas de competencia (gana más alta).

Propiedad Valor
Valor predeterminado: 0
--resource-group -g

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

--target-condition --tc -t

Condición de destino a la que se aplica una configuración de dispositivo o módulo. Las configuraciones sin condición de destino no tendrán como destino ningún dispositivo o módulo. Use el siguiente formato: "tags.environment='test'".

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

Elimine una configuración de dispositivo IoT.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parámetros requeridos

--config-id -c

Nombre de configuración del dispositivo de destino. Se permiten minúsculas y los siguientes caracteres especiales: [-+%_*!'].

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
--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

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

Enumere las configuraciones de administración automática de dispositivos de IoT en una instancia de IoT Hub.

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

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

--top

Número máximo de configuraciones que se van a devolver. De forma predeterminada, se devuelven todas las configuraciones.

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

Obtenga los detalles de una configuración de administración automática de dispositivos IoT.

az iot hub configuration show --config-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]

Parámetros requeridos

--config-id -c

Nombre de configuración del dispositivo de destino. Se permiten minúsculas y los siguientes caracteres especiales: [-+%_*!'].

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

Evalúe una métrica de usuario o sistema de destino definida en una configuración de dispositivo IoT.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type --mt {system, user}]
                                     [--resource-group]

Ejemplos

Evaluación de la métrica "warningLimit" definida por el usuario

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Evaluación de la métrica "appliedCount" del sistema

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Parámetros requeridos

--config-id -c

Nombre de configuración del dispositivo de destino. Se permiten minúsculas y los siguientes caracteres especiales: [-+%_*!'].

--metric-id -m

Métrica de destino para la evaluación.

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
--metric-type --mt

Indica qué colección de métricas se debe usar para buscar una métrica.

Propiedad Valor
Valor predeterminado: user
Valores aceptados: system, user
--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 configuration update

Actualice las propiedades especificadas de una configuración de administración automática de dispositivos IoT.

Use --set seguido de asignaciones de propiedades para actualizar una configuración.

Nota: El contenido de configuración es inmutable. Las propiedades de configuración que se pueden actualizar son "etiquetas", "métricas", "prioridad" y "targetCondition".

az iot hub configuration update --config-id
                                [--add]
                                [--auth-type {key, login}]
                                [--etag]
                                [--force-string]
                                [--hub-name]
                                [--login]
                                [--remove]
                                [--resource-group]
                                [--set]

Ejemplos

Modificar la prioridad de una configuración de dispositivo y actualizar su condición de destino

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Parámetros requeridos

--config-id -c

Nombre de configuración del dispositivo de destino. Se permiten minúsculas y los siguientes caracteres especiales: [-+%_*!'].

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.

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

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
Valor predeterminado: []
--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
--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--force-string

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

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
Valor predeterminado: False
--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
--remove

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

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
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>.

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
Valor predeterminado: []
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