Compartir a través de

az iot du instance

  • 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 du instance . Obtenga más información sobre las extensiones.

Administración de instancias de Device Update.

Comandos

Nombre Description Tipo Estado
az iot du instance create

Cree una instancia de Device Update.

 Extensión GA
az iot du instance delete

Elimine una instancia de Device Update.

 Extensión GA
az iot du instance list

Enumerar instancias de Device Update.

 Extensión GA
az iot du instance show

Mostrar una instancia de Device Update.

 Extensión GA
az iot du instance update

Actualice una instancia de Device Update.

 Extensión GA
az iot du instance wait

Bloquee hasta que se cumpla un estado de recurso de instancia deseado.

 Extensión GA

az iot du instance create

Cree una instancia de Device Update.

Este comando también se puede usar para actualizar el estado de una instancia existente.

az iot du instance create --account
                          --instance
                          --iothub-ids
                          [--diagnostics-storage-id]
                          [--enable-diagnostics {false, true}]
                          [--no-wait]
                          [--resource-group]
                          [--tags]

Ejemplos

Cree una instancia con la configuración mínima.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

Cree una instancia con diagnóstico habilitado, emparejado con una cuenta de almacenamiento proporcionada por el usuario. Incluir etiquetas.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

--iothub-ids

Identificadores de recursos de IoT Hub separados por espacios.

Parámetros opcionales

--diagnostics-storage-id

Identificador de recurso de la cuenta de almacenamiento proporcionado por el usuario para su uso en la recopilación de registros de diagnóstico.

--enable-diagnostics

Habilita la recopilación de registros de diagnóstico.

Valores aceptados: false, true
--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 de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_group=<name>.

--tags

Etiquetas del recurso. Contenedor de propiedades en pares clave-valor con el formato siguiente: a=b c=d.

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 du instance delete

Elimine una instancia de Device Update.

az iot du instance delete --account
                          --instance
                          [--no-wait]
                          [--resource-group]
                          [--yes {false, true}]

Ejemplos

Elimine una instancia asociada a la cuenta de destino.

az iot du instance delete -n {account_name} -i {instance_name}

Elimine una instancia asociada a la cuenta de destino y omita el mensaje de confirmación.

az iot du instance delete -n {account_name} -i {instance_name} -y

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--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 de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_group=<name>.

--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
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 du instance list

Enumerar instancias de Device Update.

az iot du instance list --account
                        [--resource-group]

Ejemplos

Enumera las instancias asociadas a la cuenta de destino.

az iot du instance list -n {account_name}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_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 du instance show

Mostrar una instancia de Device Update.

az iot du instance show --account
                        --instance
                        [--resource-group]

Ejemplos

Muestra los detalles de una instancia asociada a la cuenta de destino.

az iot du instance show -n {account_name} -i {instance_name}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_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 du instance update

Actualice una instancia de Device Update.

Actualmente, se pueden actualizar las siguientes propiedades de instancia: iotHubs, enableDiagnostics, diagnosticStorageProperties y etiquetas.

az iot du instance update --account
                          --instance
                          [--add]
                          [--force-string]
                          [--no-wait]
                          [--remove]
                          [--resource-group]
                          [--set]

Ejemplos

Establezca un atributo de etiqueta de instancia específico.

az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'

Habilite los diagnósticos y configure una cuenta de almacenamiento para la recopilación de registros.

az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

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: []
--force-string

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

Valor predeterminado: False
--no-wait

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

Valor predeterminado: False
--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 de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_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.

az iot du instance wait

Bloquee hasta que se cumpla un estado de recurso de instancia deseado.

az iot du instance wait --account
                        --instance
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

Ejemplos

Bloquee hasta que se haya eliminado la instancia de destino.

az iot du instance wait -n {account_name} -i {instance_name} --deleted

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

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

Intervalo de sondeo en segundos.

Valor predeterminado: 30
--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_group=<name>.

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