Share via

az sphere device app

Note

This reference is part of the azure-sphere extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az sphere device app command. Learn more about extensions.

Manage applications on the attached device.

Commands

Name Description Type Status
az sphere device app show-memory-stats

Show the memory statistics for applications on the attached device.

 Extension GA
az sphere device app show-quota

Show the storage quota and usage for applications on the attached device.

 Extension GA
az sphere device app show-status

Show the status of applications on the attached device.

 Extension GA
az sphere device app start

Start applications on the attached device.

 Extension GA
az sphere device app stop

Stop applications on the attached device.

 Extension GA

az sphere device app show-memory-stats

Show the memory statistics for applications on the attached device.

az sphere device app show-memory-stats [--device]

Examples

Show the memory statistics for applications on the attached device.

az sphere device app show-memory-stats

Show the memory statistics for applications on the specified device.

az sphere device app show-memory-stats --device <DeviceIdValue>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Property Value
Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sphere device app show-quota

Show the storage quota and usage for applications on the attached device.

az sphere device app show-quota [--component-id]
                                [--device]

Examples

Show the storage quota and usage for applications on the attached device.

az sphere device app show-quota

Show the storage quota of a specific application on the attached device.

az sphere device app show-quota --component-id 4d46953f-51d4-43d3-83a2-a808dc36cc53

Show the storage quota and usage for applications on the specified device.

az sphere device app show-quota --device <DeviceIdValue>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--component-id -i

The component ID to get the quota information for. By default, gets all components. (GUID).

Property Value
Value from: az sphere device app show-status
--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Property Value
Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sphere device app show-status

Show the status of applications on the attached device.

az sphere device app show-status [--component-id]
                                 [--device]

Examples

Show the status of applications on the attached device.

az sphere device app show-status

Show the status of a specific application on the attached device.

az sphere device app show-status --component-id 4d46953f-51d4-43d3-83a2-a808dc36cc53

Show the status of applications on the specified device.

az sphere device app show-status --device <DeviceIdValue>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--component-id -i

The component ID to show the status of; by default, all application statuses are shown. (GUID).

--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Property Value
Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sphere device app start

Start applications on the attached device.

az sphere device app start [--component-id]
                           [--debug-mode]
                           [--device]

Examples

Start applications on the attached device.

az sphere device app start

Start a specific application on the attached device.

az sphere device app start --component-id 4d46953f-51d4-43d3-83a2-a808dc36cc53

Start applications on the specified device.

az sphere device app start --device <DeviceIdValue>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--component-id -i

The component ID of the application to start. By default, all applications are started. Required if '--debug-mode' is used. (GUID).

Property Value
Value from: az sphere device app show-status
--debug-mode

Start the application in debug mode. '--component-id' must be provided.

Property Value
Default value: False
--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Property Value
Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sphere device app stop

Stop applications on the attached device.

az sphere device app stop [--component-id]
                          [--device]

Examples

Stop applications on the attached device.

az sphere device app stop

Stop a specific application on the attached device.

az sphere device app stop --component-id 4d46953f-51d4-43d3-83a2-a808dc36cc53

Stop applications on the specified device.

az sphere device app stop --device <DeviceIdValue>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--component-id -i

The component ID to stop; by default, all applications are stopped. (GUID).

Property Value
Value from: az sphere device app show-status
--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

Property Value
Value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False