az image builder output
Manage image builder template output distributors.
A customized image can be distributed as a managed image, a shared image in a shared image gallery (SIG), or as a VHD blob.
Commands
Name | Description | Type | Status |
---|---|---|---|
az image builder output add |
Add an image builder output distributor to an image builder template. |
Core | GA |
az image builder output clear |
Remove all image builder output distributors from an image builder template. |
Core | GA |
az image builder output remove |
Remove an image builder output distributor from an image builder template. |
Core | GA |
az image builder output versioning |
Manage image builder template output versioner. |
Core | GA |
az image builder output versioning remove |
Remove all versioning options on specified outputs. |
Core | GA |
az image builder output versioning set |
Set the image builder output versioner of an image builder template. |
Core | GA |
az image builder output versioning show |
Show versioning options on specified outputs. |
Core | GA |
az image builder output add
Add an image builder output distributor to an image builder template.
Must be used with --defer. The output distributor can be a managed image, a gallery image, or as a VHD blob.
az image builder output add [--artifact-tags]
[--defer]
[--gallery-image-definition]
[--gallery-name]
[--gallery-replication-regions]
[--ids]
[--is-vhd]
[--managed-image]
[--managed-image-location]
[--name]
[--output-name]
[--resource-group]
[--subscription]
[--versioning {Latest, Source}]
[--vhd-uri]
Examples
Add a managed image distributor to an image template in the cli object cache. Specify a run output name.
az image builder output add -n mytemplate -g my-group \
--managed-image my_desired_image_name --output-name managed_image_run_01 --defer
Add a shared image gallery distributor to an image template in the cli object cache. Specify its replication regions.
az image builder output add -n mytemplate -g my-group --gallery-name my_shared_gallery \
--gallery-replication-regions westus brazilsouth \
--gallery-image-definition linux_image_def --defer
Add a VHD distributor to an image template in the cli object cache.
az image builder output add -n mytemplate -g my-group \
--output-name my_vhd_image --is-vhd --defer
Add a VHD distributor with specifying storage uri to an image template in the cli object cache.
az image builder output add -n mytemplate -g my-group \
--output-name my_vhd_image --is-vhd --vhd-uri https://mystorageaccount.blob.core.windows.net/container/path_to_vhd_file --defer
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Tags that will be applied to the output artifact once it has been created by the distributor. space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Temporarily store the object in the local cache instead of sending to Azure. Use az cache
commands to view/clear.
Name or ID of the existing SIG image definition to create the customized image version with.
Property | Value |
---|---|
Parameter group: | Shared Image Gallery Arguments |
Shared image gallery name, if image definition name and not ID was provided.
Property | Value |
---|---|
Parameter group: | Shared Image Gallery Arguments |
Space-separated list of regions to replicate the image version into. Defaults to resource group's location.
Property | Value |
---|---|
Parameter group: | Shared Image Gallery Arguments |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The output is a VHD distributor.
Property | Value |
---|---|
Parameter group: | VHD Arguments |
Name or ID of the customized managed image to be created.
Property | Value |
---|---|
Parameter group: | Managed Image Arguments |
Location where the customized image will be created. Defaults to resource group's location.
Property | Value |
---|---|
Parameter group: | Managed Image Arguments |
The name of the image template.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the image builder run output. Defaults to the name of the managed image or sig image definition.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Describe how to generate new x.y.z version number for distribution.
Property | Value |
---|---|
Accepted values: | Latest, Source |
Optional Azure Storage URI for the distributed VHD blob. Omit to use the default (empty string) in which case VHD would be published to the storage account in the staging resource group.
Property | Value |
---|---|
Parameter group: | VHD Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az image builder output clear
Remove all image builder output distributors from an image builder template.
Must be used with --defer.
az image builder output clear [--defer]
[--ids]
[--name]
[--resource-group]
[--subscription]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Temporarily store the object in the local cache instead of sending to Azure. Use az cache
commands to view/clear.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of the image template.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az image builder output remove
Remove an image builder output distributor from an image builder template.
Must be used with --defer.
az image builder output remove --output-name
[--defer]
[--ids]
[--name]
[--resource-group]
[--subscription]
Required Parameters
Name of the image builder run output.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Temporarily store the object in the local cache instead of sending to Azure. Use az cache
commands to view/clear.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of the image template.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |