Share via

az sig gallery-application version

  • Reference

Manage gallery application version.

Commands

Name Description Type Status
az sig gallery-application version create

Create a gallery application version.

 Core GA
az sig gallery-application version delete

Delete a gallery application version.

 Core GA
az sig gallery-application version list

List gallery application versions.

 Core GA
az sig gallery-application version show

Get information about a gallery application version.

 Core GA
az sig gallery-application version update

Update a gallery application version.

 Core GA
az sig gallery-application version wait

Place the CLI in a waiting state until a condition is met.

 Core GA

Create a gallery application version.

az sig gallery-application version create --application-name
                                          --gallery-application-version-name
                                          --gallery-name
                                          --install-command
                                          --package-file-link
                                          --remove-command
                                          --resource-group
                                          [--config-file-name]
                                          [--default-file-link]
                                          [--end-of-life-date]
                                          [--exclude-from {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--location]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--package-file-name]
                                          [--tags]
                                          [--target-regions]
                                          [--update-command]

Create a simple gallery Application Version.

az sig gallery-application version create --gallery-name myGalleryName --application-name myGalleryApplicationName -n 1.0.0 -g myResourceGroup --package-file-link https://{myStorageAccount}.blob.core.windows.net/{myStorageContainer}/{myStorageBlob}  --install-command installCommand  --remove-command removeCommand
--application-name --gallery-application-name

The name of the gallery application.

--gallery-application-version-name --name --version-name -n

The name of the gallery application version.

--gallery-name -r

Gallery name.

--install-command

Required. The path and arguments to install the gallery application. This is limited to 4096 characters.

--package-file-link

Required. The mediaLink of the artifact, must be a readable storage page blob.

--remove-command

Required. The path and arguments to remove the gallery application. This is limited to 4096 characters.

--resource-group -g

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

--config-file-name

Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config".

--default-file-link

Optional. The default configuration link of the artifact, must be a readable storage page blob.

--end-of-life-date

The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.

--exclude-from

If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--location -l

Resource location When not specified, the location of the resource group will be used.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--package-file-name

Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--target-regions

The target regions where the Image Version is going to be replicated to. This property is updatable. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--update-command

Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters.

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.

Delete a gallery application version.

az sig gallery-application version delete [--application-name]
                                          [--gallery-application-version-name]
                                          [--gallery-name]
                                          [--ids]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]
                                          [--yes]
--application-name --gallery-application-name

The name of the gallery application.

--gallery-application-version-name --name --version-name -n

The name of the gallery application version.

--gallery-name -r

Gallery name.

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

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--yes -y

Do not prompt for confirmation.

Default value: False
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.

List gallery application versions.

az sig gallery-application version list --application-name
                                        --gallery-name
                                        --resource-group
                                        [--max-items]
                                        [--next-token]
--application-name --gallery-application-name

The name of the gallery application.

--gallery-name -r

Gallery name.

--resource-group -g

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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.

Get information about a gallery application version.

az sig gallery-application version show [--application-name]
                                        [--expand {ReplicationStatus}]
                                        [--gallery-application-version-name]
                                        [--gallery-name]
                                        [--ids]
                                        [--resource-group]
                                        [--subscription]
--application-name --gallery-application-name

The name of the gallery application.

--expand

The expand expression to apply on the operation. "ReplicationStatus" Default value is None.

Accepted values: ReplicationStatus
--gallery-application-version-name --name --version-name -n

The name of the gallery application version.

--gallery-name -r

Gallery name.

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

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

Update a gallery application version.

az sig gallery-application version update --package-file-link
                                          [--add]
                                          [--application-name]
                                          [--default-file-link]
                                          [--end-of-life-date]
                                          [--exclude-from {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--gallery-application-version-name]
                                          [--gallery-name]
                                          [--ids]
                                          [--location]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--remove]
                                          [--resource-group]
                                          [--set]
                                          [--subscription]
                                          [--tags]
                                          [--target-regions]

Update a simple gallery Application Version.

az sig gallery-application version update --gallery-name myGalleryName --application-name myGalleryApplicationName -n 1.0.0 -g myResourceGroup --package-file-link https://{myStorageAccount}.blob.core.windows.net/{myStorageContainer}/{myStorageBlob} --end-of-life-date "2050-07-01T07:00:00Z"
--package-file-link

Required. The mediaLink of the artifact, must be a readable storage page blob.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--application-name --gallery-application-name

The name of the gallery application.

--default-file-link

Optional. The default configuration link of the artifact, must be a readable storage page blob.

--end-of-life-date

The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable.

--exclude-from

If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--gallery-application-version-name --name --version-name -n

The name of the gallery application version.

--gallery-name -r

Gallery name.

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

--location -l

Resource location.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--target-regions

The target regions where the Image Version is going to be replicated to. This property is updatable. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.

Place the CLI in a waiting state until a condition is met.

az sig gallery-application version wait [--application-name]
                                        [--created]
                                        [--custom]
                                        [--deleted]
                                        [--exists]
                                        [--expand {ReplicationStatus}]
                                        [--gallery-application-version-name]
                                        [--gallery-name]
                                        [--ids]
                                        [--interval]
                                        [--resource-group]
                                        [--subscription]
                                        [--timeout]
                                        [--updated]
--application-name --gallery-application-name

The name of the gallery application.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--expand

The expand expression to apply on the operation. "ReplicationStatus" Default value is None.

Accepted values: ReplicationStatus
--gallery-application-version-name --name --version-name -n

The name of the gallery application version.

--gallery-name -r

Gallery name.

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

--interval

Polling interval in seconds.

Default value: 30
--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.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.