image

Manages Azure Sphere images on disk.

Operation	Description
add	Uploads a new image.
download	Downloads an image.
show	Displays information about the specified image.

add

Uploads a new image to your Azure Sphere tenant.

Required parameters

Parameter	Type	Description	Supported version
--image	String	Specifies the path to the image to be uploaded.	Azure Sphere CLI
-f, --filepath	String	Specifies the path to the image to be uploaded.	Azure Sphere classic CLI

Optional parameters

Parameter	Type	Description	Supported version
-t, --tenant	GUID or name	Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name.	Azure Sphere CLI
--temporary	Boolean	Marks the image package as temporary. This parameter is intended for use during the manufacturing process.	- Azure Sphere CLI - Azure Sphere classic CLI
--force	Boolean	Forces uploading of images using a Beta API.	- Azure Sphere CLI - Azure Sphere classic CLI
-r, --regional-data-boundary	String	Regional data boundary for this image. Allowed values: EU, None. The default value is None. If no value is specified the default value will be used. For more information, see Configure crash dumps - Pivacy considerations	Azure Sphere CLI

Global parameters

The following global parameters are available for the Azure Sphere CLI:

Parameter	Description
--debug	Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report.
-h, --help	Prints CLI reference information about commands and their arguments and lists available subgroups and commands.
--only-show-errors	Shows only errors, suppressing warnings.
-o, --output	Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands.
--query	Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples.
--verbose	Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs.

Note

If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.

Example

Azure Sphere CLI

azsphere image add --image C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage --temporary
Uploading image from file 'C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage':
 --> Image ID:       d788fdd1-28eb-4477-9818-a4734289f2f1
 --> Component ID:   99d419ef-296d-43b0-ade1-809efe3a7aba
 --> Component name: 'QuickStart-AzureSphereBlink1'
Retaining temporary state for uploaded image.
Successfully uploaded image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1' and name 'QuickStart-AzureSphereBlink1' to component with ID '99d419ef-296d-43b0-ade1-809efe3a7aba'.

Azure Sphere classic CLI

azsphere image add --filepath C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage --temporary
Uploading image from file 'C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage':
 --> Image ID:       d788fdd1-28eb-4477-9818-a4734289f2f1
 --> Component ID:   99d419ef-296d-43b0-ade1-809efe3a7aba
 --> Component name: 'QuickStart-AzureSphereBlink1'
Retaining temporary state for uploaded image.
Successfully uploaded image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1' and name 'QuickStart-AzureSphereBlink1' to component with ID '99d419ef-296d-43b0-ade1-809efe3a7aba'.

Note: The Azure Sphere classic CLI is retiring. We recommend using the new Azure Sphere CLI.

download

Downloads an existing image from your Azure Sphere tenant.

Required parameters

Parameter	Type	Description	Supported version
-i, --image	String	Specifies the ID of the image to download. Run the azsphere image add command to get the image ID.	Azure Sphere CLI
--destination	String	Specifies the path and filename in which to save the image. The file path can be an absolute or relative path.	Azure Sphere CLI
-i, --imageid	GUID	Specifies the ID of the image to download. Run the azsphere image add command to get the image ID.	Azure Sphere classic CLI
-o, --output	String	Specifies the ID of the image to download.	Azure Sphere classic CLI

Optional parameters

Parameter	Type	Description	Supported version
-t, --tenant	GUID or name	Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name.	Azure Sphere CLI

Global parameters

The following global parameters are available for the Azure Sphere CLI:

Parameter	Description
--debug	Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report.
-h, --help	Prints CLI reference information about commands and their arguments and lists available subgroups and commands.
--only-show-errors	Shows only errors, suppressing warnings.
-o, --output	Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands.
--query	Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples.
--verbose	Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs.

Note

If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.

Example

Azure Sphere CLI

azsphere image download --image d788fdd1-28eb-4477-9818-a4734289f2f1 --destination AzureSphereBlink1.image
Getting the image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1'.
 ---------
 Result
 =========
 Succeeded
 ---------

Azure Sphere classic CLI

azsphere image download --imageid d788fdd1-28eb-4477-9818-a4734289f2f1 --output AzureSphereBlink1.image
Getting the image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1'.
Successfully downloaded image to location 'AzureSphereBlink1.image'.

Note: The Azure Sphere classic CLI is retiring. We recommend using the new Azure Sphere CLI.

show

Shows details of an existing image from your Azure Sphere tenant.

Required parameters

Parameter	Type	Description	Supported version
-i, --image	GUID	Specifies the ID of the image to get the details for. Run the azsphere image add command to get the image ID.	Azure Sphere CLI
-i, --imageid	GUID	Specifies the ID of the image to get the details for. Run the azsphere image add command to get the image ID.	Azure Sphere classic CLI

Optional parameters

Parameter	Type	Description	Supported version
-t, --tenant	GUID or name	Specifies the tenant to perform this operation in. Overrides the default selected tenant. You can specify either the tenant ID or tenant name.	Azure Sphere CLI

Global parameters

The following global parameters are available for the Azure Sphere CLI:

Parameter	Description
--debug	Increases logging verbosity to show all debug logs. If you find a bug, provide output generated with the --debug flag on when submitting a bug report.
-h, --help	Prints CLI reference information about commands and their arguments and lists available subgroups and commands.
--only-show-errors	Shows only errors, suppressing warnings.
-o, --output	Changes the output format. The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs table. To learn more about the available output formats, see Output format for Azure Sphere CLI commands.
--query	Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. See JMESPath tutorial and Query Azure CLI command output for more information and examples.
--verbose	Prints information about resources created in Azure Sphere during an operation and other useful information. Use --debug for full debug logs.

Note

If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.

Example

Azure Sphere CLI

azsphere image show --image d788fdd1-28eb-4477-9818-a4734289f2f1
------------------------------------ ------------------------------------ ---------------------------- ------------- ------------  ---------------------
ImageId                              ComponentId                          Name                         SigningStatus ImageType     RegionalDataBoundary
========================================================================================================================================================
d788fdd1-28eb-4477-9818-a4734289f2f1 99d419ef-296d-43b0-ade1-809efe3a7aba QuickStart-AzureSphereBlink1 Succeeded     Applications  None
------------------------------------ ------------------------------------ ---------------------------- ------------- ------------  ---------------------

Azure Sphere classic CLI

azsphere image show --imageid d788fdd1-28eb-4477-9818-a4734289f2f1
Getting the details for image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1'.
Successfully retrieved image package details:
 -> Image ID:       d788fdd1-28eb-4477-9818-a4734289f2f1
 -> Component ID:   99d419ef-296d-43b0-ade1-809efe3a7aba
 -> Name:           QuickStart-AzureSphereBlink1
 -> Signing status: Succeeded
 -> Image type:     Application

Note: The Azure Sphere classic CLI is retiring. We recommend using the new Azure Sphere CLI.