Share via

az image builder validator

  • Reference

Manage image builder template validate.

Commands

Name Description Type Status
az image builder validator add

Add validate to an existing image builder template.

 Core GA
az image builder validator remove

Remove validate from an existing image builder template.

 Core GA
az image builder validator show

Show validate of an existing image builder template.

 Core GA

az image builder validator add

Add validate to an existing image builder template.

Must be used with --defer.

az image builder validator add [--continue-distribute-on-failure {false, true}]
                               [--defer]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--source-validation-only {false, true}]
                               [--subscription]

Examples

Add validate with continue distribute on failure set to true. If not specified, the default value of continue distribute on failure is false. If validation fails and this field is set to false, output image(s) will not be distributed.

az image builder validator add -n myTemplate -g myGroup --continue-distribute-on-failure true --defer

Add validate with source validation only set to true. If not specified, the default value of source validation only is false. If this field is set to true, the image specified in the source section will directly be validated.

az image builder validator add -n myTemplate -g myGroup --source-validation-only true --defer

Add validate with source validation only and continue distribute on failure set to false.

az image builder validator add -n myTemplate -g myGroup --defer

Optional Parameters

--continue-distribute-on-failure --dis-on-failure

If validation fails and this parameter is set to false, output image(s) will not be distributed.

Accepted values: false, true
Default value: False
--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--ids

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

The name of the image template.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source-validation-only

If this parameter is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image.

Accepted values: false, true
Default value: False
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 image builder validator remove

Remove validate from an existing image builder template.

Must be used with --defer.

az image builder validator remove [--defer]
                                  [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Remove validate from an existing image builder template.

az image builder validator remove -n myTemplate -g myGroup --defer

Optional Parameters

--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--ids

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

The name of the image template.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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

Show validate of an existing image builder template.

Must be used with --defer.

az image builder validator show [--defer]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Show validate of an existing image builder template.

az image builder validator show -n myTemplate -g myGroup --defer

Optional Parameters

--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--ids

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

The name of the image template.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.