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

az sig gallery-application version create

Create a gallery Application Version.

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

Examples

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

Required Parameters

--application-name

The name of the gallery Application.

--gallery-name -r

Gallery name.

--install-command

The path and arguments to install the gallery application.

--name --version-name -n

The name of the gallery Application Version.

--package-file-link

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

--remove-command

The path and arguments to remove the gallery application.

--resource-group -g

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

Optional Parameters

--config-file-name

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

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: false, true

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Default value: False

--package-file-name

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] ...]. Use "" to clear existing tags.

--target-regions

The target regions where the Image Version isgoing to be replicated to. This property is updatable. Expected value: json-string/json-file/@json-file.

--update-command

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.

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 sig gallery-application version delete

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]

Optional Parameters

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

az sig gallery-application version list

List gallery application versions.

az sig gallery-application version list --application-name
                                        --gallery-name
                                        --resource-group

Required Parameters

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

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 sig gallery-application version show

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]

Optional Parameters

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

--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 sig gallery-application version update

Update a gallery Application Version.

az sig gallery-application version update --application-name
                                          --gallery-name
                                          --name
                                          --package-file-link
                                          --resource-group
                                          [--default-file-link]
                                          [--end-of-life-date]
                                          [--exclude-from {false, true}]
                                          [--location]
                                          [--no-wait]
                                          [--tags]
                                          [--target-regions]

Examples

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"

Required Parameters

--application-name

The name of the gallery Application.

--gallery-name -r

Gallery name.

--name --version-name -n

The name of the gallery Application Version.

--package-file-link

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

--resource-group -g

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

Optional Parameters

--default-file-link

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: false, true

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Default value: False

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--target-regions

The target regions where the Image Version isgoing to be replicated to. This property is updatable. Expected value: json-string/json-file/@json-file.

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 sig gallery-application version wait

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]

Optional Parameters

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

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

Share via

az sig gallery-application version

Commands

az sig gallery-application version create

Examples

Required Parameters

Optional Parameters

az sig gallery-application version delete

Optional Parameters

az sig gallery-application version list

Required Parameters

az sig gallery-application version show

Optional Parameters

az sig gallery-application version update

Examples

Required Parameters

Optional Parameters

az sig gallery-application version wait

Optional Parameters

Additional resources