az azurestackhci image
Note
This reference is part of the azurestackhci extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az azurestackhci image command. Learn more about extensions.
Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage images with azurestackhci.
Commands
Name | Description | Type | Status |
---|---|---|---|
az azurestackhci image create |
Create a gallery image. |
Extension | Experimental |
az azurestackhci image delete |
Delete an image. |
Extension | Experimental |
az azurestackhci image list |
List all gallery images. |
Extension | Experimental |
az azurestackhci image show |
Get the details of an image. |
Extension | Experimental |
az azurestackhci image update |
Update an image. |
Extension | Experimental |
az azurestackhci image create
Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a gallery image.
az azurestackhci image create --name
--resource-group
[--extended-location]
[--image-path]
[--location]
[--offer]
[--os-type]
[--publisher]
[--sku]
[--storagepath-id]
[--tags]
[--version]
Examples
PutGalleryImage
az azurestackhci image create --extended-location name="/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location" type="CustomLocation" --location "West US2" --storagepath-id "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storagecontainers/test-storagepath" --image-path "C:\\test.vhdx" --name "test-gallery-image" --resource-group "test-rg"
Required Parameters
Name of the gallery image.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Usage: --extended-location type=XX name=XX
type: The extended location type. name: The extended location name.
Location/Path of the image the gallery image should be created from.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Offer for Marketplace image.
Usage: --offer.
OS Type [Windows, Linux].
Publisher for Marketplace image.
Usage: --publisher.
Sku for Marketplace image.
Usage: --sku.
Azure ID of the storagepath which is used to store Gallery Images.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Version for Marketplace image.
Usage: --version.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az azurestackhci image delete
Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete an image.
az azurestackhci image delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Examples
DeleteGalleryImage
az azurestackhci image delete --name "test-gallery-image" --resource-group "test-rg"
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the gallery image.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az azurestackhci image list
Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all gallery images.
az azurestackhci image list [--resource-group]
Examples
ListGalleryImageByResourceGroup
az azurestackhci image list --resource-group "test-rg"
ListGalleryImageByResourceGroup
az azurestackhci image list
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az azurestackhci image show
Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the details of an image.
az azurestackhci image show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
GetGalleryImage
az azurestackhci image show --name "test-gallery-image" --resource-group "test-rg"
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the gallery image.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az azurestackhci image update
Command group 'azurestackhci' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update an image.
az azurestackhci image update [--ids]
[--name]
[--resource-group]
[--subscription]
[--tags]
Examples
UpdateGalleryImage
az azurestackhci image update --tags additionalProperties="sample" --name "test-gallery-image" --resource-group "test-rg"
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the gallery image.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.