az sig gallery-application

Reference

Manage gallery application.

Commands

Name	Description	Type	Status
az sig gallery-application create	Create a gallery Application Definition.	Core	GA
az sig gallery-application delete	Delete a gallery Application.	Core	GA
az sig gallery-application list	List gallery Application Definitions in a gallery.	Core	GA
az sig gallery-application show	Get information about a gallery Application Definition.	Core	GA
az sig gallery-application update	Update a gallery Application Definition.	Core	GA
az sig gallery-application version	Manage gallery application version.	Core	GA
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 wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az sig gallery-application create

Create a gallery Application Definition.

az sig gallery-application create --application-name
                                  --gallery-name
                                  --os-type {Linux, Windows}
                                  --resource-group
                                  [--description]
                                  [--location]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--tags]

Examples

Create a simple gallery Application.

az sig gallery-application create --gallery-name MyGallery --name AppName -g MyResourceGroup --os-type windows

Required Parameters

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

The name of the gallery application.

--gallery-name -r

Gallery name.

--os-type

This property allows you to specify the supported type of the OS that application is built for.

Possible values are:

Windows

Linux.

Accepted values: Linux, Windows

--resource-group -g

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

Optional Parameters

--description

The description of this gallery Application Definition resource. This property is updatable.

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

--tags

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

az sig gallery-application delete

Delete a gallery Application.

az sig gallery-application delete [--application-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 --name -n

The name of the gallery application.

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

List gallery Application Definitions in a gallery.

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

Required Parameters

--gallery-name -r

Gallery name.

--resource-group -g

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

Optional Parameters

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

az sig gallery-application show

Get information about a gallery Application Definition.

az sig gallery-application show [--application-name]
                                [--gallery-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

Optional Parameters

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

The name of the gallery application.

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

Update a gallery Application Definition.

az sig gallery-application update [--add]
                                  [--application-name]
                                  [--description]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--gallery-name]
                                  [--ids]
                                  [--location]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--tags]

Examples

Update a simple gallery Application.

az sig gallery-application update --gallery-name GalleryName --name AppName -g MyResourceGroup --description Description --tags tag=MyTag

Optional Parameters

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

The name of the gallery application.

--description

The description of this gallery Application Definition resource. This property is updatable.

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

Gallery name.

--ids

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

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

az sig gallery-application wait

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

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

Optional Parameters

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

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

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

Commands

az sig gallery-application create

Examples

Required Parameters

Optional Parameters

az sig gallery-application delete

Optional Parameters

az sig gallery-application list

Required Parameters

Optional Parameters

az sig gallery-application show

Optional Parameters

az sig gallery-application update

Examples

Optional Parameters

az sig gallery-application wait

Optional Parameters

Additional resources