az image builder error-handler
Manage image builder template error handler.
Commands
Name | Description | Type | Status |
---|---|---|---|
az image builder error-handler add |
Add error handler to an existing image builder template. |
Core | GA |
az image builder error-handler remove |
Remove error handler from an existing image builder template. |
Core | GA |
az image builder error-handler show |
Show error handler of an existing image builder template. |
Core | GA |
az image builder error-handler add
Add error handler to an existing image builder template.
Must be used with --defer.
az image builder error-handler add [--defer]
[--ids]
[--name]
[--on-customizer-error {abort, cleanup}]
[--on-validation-error {abort, cleanup}]
[--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 |
If there is a customizer error and this field is set to "cleanup", the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to "abort", the build VM will be preserved.
Property | Value |
---|---|
Accepted values: | abort, cleanup |
If there is a validation error and this field is set to "cleanup", the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to "abort", the build VM will be preserved.
Property | Value |
---|---|
Accepted values: | abort, cleanup |
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 error-handler remove
Remove error handler from an existing image builder template.
Must be used with --defer.
az image builder error-handler remove [--defer]
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Remove error handler from an existing image builder template.
az image builder error-handler remove -n myTemplate -g myGroup --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.
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 error-handler show
Show error handler of an existing image builder template.
Must be used with --defer.
az image builder error-handler show [--defer]
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Show error handler of an existing image builder template.
az image builder error-handler show -n myTemplate -g myGroup --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.
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 |