Share via

az sphere image

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

Manage images in your resource group and catalog.

Commands

Name Description Type Status
az sphere image add

Add an image to your catalog from your local machine.

 Extension GA
az sphere image list

List all images in your resource group and catalog.

 Extension GA
az sphere image show

Show details of an existing image from your catalog.

 Extension GA

az sphere image add

Add an image to your catalog from your local machine.

az sphere image add --catalog
                    --image-path
                    --resource-group
                    [--regional-data-boundary {EU, None}]

Examples

Add a new image in resource group "MyResourceGroup" and catalog "MyCatalog".

az sphere image add --resource-group MyResourceGroup --catalog MyCatalog --image-path MyImage.imagepackage

Add a new image in resource group "MyResourceGroup", catalog "MyCatalog", and Regional data boundary "EU".

az sphere image add --resource-group MyResourceGroup --catalog MyCatalog --image-path MyImage.imagepackage --regional-data-boundary EU

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.

--image-path -img

Path to a local image file.

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

--regional-data-boundary -r

Regional data boundary for this image.

accepted values: EU, None
default value: None
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 image list

List all images in your resource group and catalog.

az sphere image list --catalog
                     --resource-group

Examples

List all images in a resource group and catalog.

az sphere image list --resource-group MyResourceGroup --catalog MyCatalog

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.

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 image show

Show details of an existing image from your catalog.

az sphere image show --catalog
                     --image
                     --resource-group

Examples

Show details of an image using resource group, catalog name, and image ID.

az sphere image show --resource-group MyResourceGroup --catalog MyCatalog --image adb44b96-2642-4643-8c30-5f681f466425

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.

--image

The image ID.

value from: az sphere image 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.

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.