Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az sig gallery-application

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-application-name --name
 --gallery-name
 --os-type {Linux, Windows}
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--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.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

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

az sig gallery-application delete

Delete a gallery Application.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

The name of the gallery application.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--gallery-name -r

Gallery name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

az sig gallery-application show

Get information about a gallery Application Definition.

az sig gallery-application show [--application-name --gallery-application-name --name]
 [--gallery-name]
 [--ids]
 [--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.

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

The name of the gallery application.

Property	Value
Parameter group:	Resource Id Arguments

--gallery-name -r

Gallery name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

az sig gallery-application update

Update a gallery Application Definition.

az sig gallery-application update [--acquire-policy-token]
 [--add]
 [--application-name --gallery-application-name --name]
 [--change-reference]
 [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

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

The name of the gallery application.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--gallery-name -r

Gallery name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--location -l

Resource location.

--no-wait

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

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

az sig gallery-application wait

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

The name of the gallery application.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--gallery-name -r

Gallery name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Feedback

Was this page helpful?

URL: https://learn.microsoft.com/en-us/cli/azure/sig/gallery-application?view=azure-cli-latest

⇱ az sig gallery-application | Microsoft Learn

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

Feedback