Share via

az sphere device capability

  • Reference

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 capability command. Learn more about extensions.

Manage device capability configurations.

Commands

Name Description Type Status
az sphere device capability apply

Temporarily apply a capability session on the attached device.

 Extension GA
az sphere device capability download

Download a device capability file from the Azure Sphere Security Service.

 Extension GA
az sphere device capability show-attached

Show the current device capability configuration of the attached device.

 Extension GA
az sphere device capability update

Update the device capability configuration for the attached device.

 Extension GA

az sphere device capability apply

Temporarily apply a capability session on the attached device.

az sphere device capability apply [--capability-file]
                                  [--none {false, true}]

Examples

Apply temporarily the device capability session.

az sphere device capability apply --capability-file myCapabilities.cap

End the temporarily applied device capability session.

az sphere device capability apply --none

Optional Parameters

--capability-file

The path and filename of the capability file. You can provide a relative or absolute path.

--none -n

End the temporary capability session on the attached device.

Accepted values: false, true
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az sphere device capability download

Download a device capability file from the Azure Sphere Security Service.

az sphere device capability download --catalog
                                     --resource-group
                                     [--device]
                                     [--output-file]
                                     [--type {ApplicationDevelopment, FieldServicing}]

Examples

Download the "ApplicationDevelopment" capability for a device using resource group, catalog name, device ID, and capability.

az sphere device capability download --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue> --type ApplicationDevelopment --output-file myCapabilities.cap

Download the "None" capability for a device using resource group, catalog name, and device ID.

az sphere device capability download --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue> --output-file myCapabilities.cap

Required Parameters

--catalog -c

The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list.

--resource-group -g

Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list.

Optional Parameters

--device -d

The device to target for this command. This is required when no device or multiple devices are attached, to disambiguate which device to target. If the device is attached, you may provide either device ID, IP address, or Local Connection ID. Otherwise you must provide the device ID only.

Value from: az sphere device list
--output-file -of

Path and file name in which to download capabilities. If this parameter is not set, the file will be saved in the current folder with a default name (capability-device.cap).

--type -t

Space-separated list of capabilities to download. If this parameter is not set, the capability "None" will be downloaded.

Accepted values: ApplicationDevelopment, FieldServicing
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az sphere device capability show-attached

Show the current device capability configuration of the attached device.

az sphere device capability show-attached [--device]

Examples

Show the device capability configuration of the attached device.

az sphere device capability show-attached

Show the device capability configuration of the specified device.

az sphere device capability show-attached --device <DeviceIdValue>

Optional Parameters

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

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az sphere device capability update

Update the device capability configuration for the attached device.

az sphere device capability update --capability-file
                                   [--device]

Examples

Update the device capability configuration for the attached device.

az sphere device capability update --capability-file myCapabilities.cap

Update the device capability configuration for the specified device.

az sphere device capability update --capability-file myCapabilities.cap --device <DeviceIdValue>

Required Parameters

--capability-file

The path and filename to the device capability configuration file to apply.

Optional Parameters

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

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.