az iot edge deployment

  • Referencia

Nota:

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

Administrar implementaciones de IoT Edge a escala.

Comandos

Nombre Description Tipo Estado
az iot edge deployment create

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

 Extensión GA
az iot edge deployment delete

Elimine una implementación de IoT Edge.

 Extensión GA
az iot edge deployment list

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

 Extensión GA
az iot edge deployment show

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

 Extensión GA
az iot edge deployment show-metric

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

 Extensión GA
az iot edge deployment update

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

 Extensión GA

az iot edge deployment create

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

El contenido de implementación es json y en forma de {"modulesContent":{...}} o {"content":{"modulesContent":{...}}}.

De forma predeterminada, las propiedades de los módulos del sistema $edgeAgent y $edgeHub se validan con esquemas instalados con la extensión de IoT. Esta validación está pensada para implementaciones base. Si el esquema correspondiente no está disponible o no se detecta el formato de implementación base, se omitirá este paso. La validación del esquema se puede deshabilitar mediante el modificador --no-validation.

Una implementación perimetral se clasifica como superpuesta si un módulo tiene propiedades.desired.* definidas. Cualquier dispositivo perimetral destinado a una implementación en capas, primero necesita una implementación base aplicada.

Las implementaciones superpuestas destinadas a un dispositivo deben tener una prioridad más alta que la implementación base para ese dispositivo.

Nota: Si el campo properties.desired de un módulo gemelo se establece en una implementación superpuesta, properties.desired sobrescribirá las propiedades deseadas para ese módulo en cualquier implementación de prioridad inferior.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Ejemplos

Cree una implementación con etiquetas (ejemplo de sintaxis de Bash) que se aplique a los dispositivos en "building 9" y el entorno sea "test".

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Cree una implementación con etiquetas (ejemplo de sintaxis de PowerShell) que se aplique a los dispositivos etiquetados con el entorno "dev".

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Cree una implementación superpuesta que se aplique a los dispositivos etiquetados con el entorno "dev". Tanto las métricas de usuario como el contenido de los módulos definidos en línea (ejemplo de sintaxis de PowerShell). Tenga en cuenta que esto está en formato de implementación en capas como properties.desired.* se ha definido.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

Cree una implementación en capas que se aplique a los dispositivos en "building 9" y environment "test". Tanto las métricas de usuario como el contenido de los módulos definidos en línea (ejemplo de sintaxis de Bash). Tenga en cuenta que esto está en formato de implementación en capas como properties.desired.* se ha definido.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

Cree una implementación que se aplique a los dispositivos en "building 9" y environment "test". Tanto las métricas de usuario como el contenido de los módulos definidos a partir del archivo.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Cree una implementación cuya definición procede del archivo con entrada independiente del shell de etiquetas y métricas.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parámetros requeridos

--content -k

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

--deployment-id -d

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

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

--lab --labels

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

--layered

Las implementaciones superpuestas permiten definir las propiedades deseadas en $edgeAgent, $edgeHub y módulos de usuario que se superponen a una implementación base. Las propiedades especificadas en una implementación superpuesta se combinarán con las propiedades de la implementación base. Las propiedades con la misma ruta de acceso se sobrescribirán en función de la prioridad de implementación. Esta opción es un alias para --no-validation.

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

--metrics -m

Definiciones de métricas de usuario de implementación de IoT Edge. Proporcione la ruta de acceso del archivo o json sin formato. Las métricas de usuario están en forma de {"queries":{...}} o {"metrics":{"queries":{...}}}. Se recomienda usar --custom-metric-queries en lugar de --metrics.

--no-validation

Deshabilita la validación del esquema del lado cliente para la creación de la implementación perimetral.

Valores aceptados: false, true
Valor predeterminado: False
--pri --priority

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

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 implementación perimetral. Las implementaciones sin ninguna condición de destino no tendrán como destino ningún dispositivo. Use el siguiente formato: "tags.environment='test'".

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 edge deployment delete

Elimine una implementación de IoT Edge.

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

Parámetros requeridos

--deployment-id -d

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

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

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

--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 edge deployment list

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

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

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
--hub-name -n

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

--login -l

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

--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 implementaciones que se van a devolver. De forma predeterminada, se devuelven todas las implementaciones.

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 edge deployment show

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

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

Parámetros requeridos

--deployment-id -d

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

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
--hub-name -n

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

--login -l

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

--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 edge deployment show-metric

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

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

Ejemplos

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

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Evaluación de la métrica de usuario "myCustomMetric"

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Parámetros requeridos

--deployment-id -d

Nombre de implementación 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

--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
--hub-name -n

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

--login -l

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

--metric-type --mt

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

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

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

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

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

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

Ejemplos

Modificar las etiquetas y la condición de destino de una implementación perimetral existente

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Parámetros requeridos

--deployment-id -d

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

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: []
--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
--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.

Valor predeterminado: False
--hub-name -n

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

--login -l

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

--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: []
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.