az sig

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage shared image gallery.

Commands

Name Description Type Status
az sig create

Create a shared image gallery.

 Core GA
az sig create (image-gallery extension)

Create a shared image gallery.

 Extension GA
az sig delete

Delete a Shared Image Gallery.

 Core GA
az sig gallery-application

Manage gallery application.

 Core GA
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 of the sig gallery-application is met.

 Core GA
az sig image-definition

Manage shared gallery image with VM.

 Core and Extension GA
az sig image-definition create

Create a gallery image definition.

 Core GA
az sig image-definition delete

Delete a gallery image.

 Core GA
az sig image-definition list

List gallery image definitions in a gallery.

 Core GA
az sig image-definition list-community

List VM Image definitions in a gallery community.

 Core GA
az sig image-definition list-community (image-gallery extension)

List VM Image definitions in a gallery community (preview).

 Extension Experimental
az sig image-definition list-shared

List VM Image definitions in a gallery shared directly to your subscription or tenant.

 Core GA
az sig image-definition show

Get information about a gallery image definition.

 Core GA
az sig image-definition show-community

Get a community gallery image.

 Core GA
az sig image-definition show-community (image-gallery extension)

Get an image in a gallery community (preview).

 Extension Experimental
az sig image-definition show-shared

Get a shared gallery image.

 Core GA
az sig image-definition update

Update a VM Image definition.

 Core GA
az sig image-definition wait

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

 Core GA
az sig image-version

Manage shared gallery image version with VM.

 Core and Extension GA
az sig image-version create

Create a new image version.

 Core GA
az sig image-version delete

Delete a gallery image version.

 Core GA
az sig image-version list

List gallery image versions in a gallery image definition.

 Core GA
az sig image-version list-community

List VM Image Versions in a gallery community.

 Core GA
az sig image-version list-community (image-gallery extension)

List VM Image Versions in a gallery community (preview).

 Extension Experimental
az sig image-version list-shared

List VM Image Versions in a gallery shared directly to your subscription or tenant.

 Core GA
az sig image-version show

Retrieves information about a gallery image version.

 Core GA
az sig image-version show-community

Get a community gallery image version.

 Core GA
az sig image-version show-community (image-gallery extension)

Get an image version in a gallery community (preview).

 Extension Experimental
az sig image-version show-shared

Get an image version in a gallery shared directly to your subscription or tenant.

 Core GA
az sig image-version undelete

Restore soft deleted Image Version.

 Core Preview
az sig image-version update

Update a share image version.

 Core GA
az sig image-version wait

Wait for image version related operation.

 Core GA
az sig list

List galleries under a resource group.

 Core GA
az sig list-community

List all community galleries shared directly to your subscription or tenant.

 Core GA
az sig list-shared

List all shared galleries shared directly to your subscription or tenant.

 Core GA
az sig share

Manage gallery sharing profile.

 Core and Extension GA
az sig share add

Share gallery with subscriptions and tenants.

 Core GA
az sig share enable-community

Allow to share gallery to the community.

 Core GA
az sig share enable-community (image-gallery extension)

Allow to share gallery to the community.

 Extension GA
az sig share remove

Stop sharing gallery with a subscription or tenant.

 Core GA
az sig share reset

Disable gallery from being shared with subscription or tenant.

 Core GA
az sig share wait

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

 Core GA
az sig show

Retrieve information about a Shared Image Gallery.

 Core GA
az sig show-community

Get a community gallery by gallery public name.

 Core GA
az sig show-community (image-gallery extension)

Get a gallery that has been community (preview).

 Extension Experimental
az sig show-shared

Get a gallery that has been shared directly to your subscription or tenant.

 Core GA
az sig update

Update a share image gallery.

 Core GA

az sig create

Create a shared image gallery.

az sig create --gallery-name
              --resource-group
              [--description]
              [--eula]
              [--location]
              [--permissions {Community, Groups, Private}]
              [--public-name-prefix]
              [--publisher-email]
              [--publisher-uri]
              [--soft-delete {false, true}]
              [--tags]

Examples

Create a shared image gallery

az sig create --resource-group MyResourceGroup --gallery-name MyGallery

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

--description

The description of the gallery.

--eula

Community gallery publisher eula.

--location -l

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

--permissions

This property allows you to specify the permission of sharing gallery.

Accepted values: Community, Groups, Private
--public-name-prefix

Community gallery public name prefix.

--publisher-email

Community gallery publisher contact email.

--publisher-uri

Community gallery publisher uri.

--soft-delete
Deprecated

Argument '--soft-delete' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Enable soft-deletion for resources in this gallery, allowing them to be recovered within retention time.

Accepted values: false, true
--tags

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

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 create (image-gallery extension)

Create a shared image gallery.

az sig create --gallery-name
              --resource-group
              [--description]
              [--eula]
              [--location]
              [--permissions {Community, Groups, Private}]
              [--public-name-prefix]
              [--publisher-email]
              [--publisher-uri]
              [--soft-delete {false, true}]
              [--tags]

Examples

Create a shared image gallery

az sig create --resource-group MyResourceGroup --gallery-name MyGallery

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

--description

The description of the gallery.

--eula

Community gallery license agreement and privacy statement.

--location -l

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

--permissions
Experimental

This property allows you to specify the permission of sharing gallery.

Accepted values: Community, Groups, Private
--public-name-prefix

Community gallery public name prefix.

--publisher-email

Community gallery publisher contact email.

--publisher-uri

Community gallery publisher uri.

--soft-delete
Preview

Enable soft-deletion for resources in this gallery, allowing them to be recovered within retention time.

Accepted values: false, true
--tags

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

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 delete

Delete a Shared Image Gallery.

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

Optional Parameters

--gallery-name -r

The name of the Shared Image Gallery to be deleted.

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

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 list

List galleries under a resource group.

az sig list [--resource-group]

Optional Parameters

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

List all community galleries shared directly to your subscription or tenant.

az sig list-community [--location]
                      [--marker]
                      [--show-next-marker]

Examples

List community galleries shared directly to your subscription in a given location

az sig list-community --location myLocation

List paging community galleries shared directly to your tenant in a given location according to next marker

az sig list-community --location myLocation --marker nextMarker

Optional Parameters

--location -l

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

--marker

A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. If specified, this generator will begin returning results from the point where the previous generator stopped.

--show-next-marker

Show nextMarker in result when specified.

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

List all shared galleries shared directly to your subscription or tenant.

az sig list-shared --location
                   [--shared-to {tenant}]

Examples

List shared galleries shared directly to your subscription in a given location

az sig list-shared --location myLocation

List shared galleries shared directly to your tenant in a given location

az sig list-shared --location myLocation --shared-to tenant

Required Parameters

--location -l

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

Optional Parameters

--shared-to

The query parameter to decide what shared galleries to fetch when doing listing operations. If not specified, list by subscription id.

Accepted values: tenant
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 show

Retrieve information about a Shared Image Gallery.

az sig show [--gallery-name]
            [--ids]
            [--resource-group]
            [--select]
            [--sharing-groups]
            [--subscription]

Optional Parameters

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

--select

The select expression to apply on the operation.

--sharing-groups

The expand query option to query shared gallery groups.

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

Get a community gallery by gallery public name.

az sig show-community [--ids]
                      [--location]
                      [--name]
                      [--subscription]

Optional Parameters

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

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

--name --public-gallery-name -n

The public name of the community gallery.

--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 show-community (image-gallery extension)

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a gallery that has been community (preview).

Get a gallery that has been community (private preview feature, please contact community image gallery team by email sigpmdev@microsoft.com to register for preview if you're interested in using this feature).

az sig show-community [--ids]
                      [--location]
                      [--public-gallery-name]
                      [--subscription]

Examples

Get a gallery that has been community in the given location.

az sig show-community --public-gallery-name publicGalleryName --location myLocation

Optional Parameters

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

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

--public-gallery-name

The public name of community gallery.

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

Get a gallery that has been shared directly to your subscription or tenant.

az sig show-shared [--gallery-unique-name]
                   [--ids]
                   [--location]
                   [--subscription]

Examples

Get a gallery that has been shared directly to your subscription or tenant in the given location.

az sig show-shared --gallery-unique-name MyGalleryUniqueName --location MyLocation

Optional Parameters

--gallery-unique-name --name -n

The unique name of the Shared Gallery.

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

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

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

Update a share image gallery.

az sig update --gallery-name
              --resource-group
              [--add]
              [--eula]
              [--force-string]
              [--permissions {Community, Groups, Private}]
              [--public-name-prefix]
              [--publisher-email]
              [--publisher-uri]
              [--remove]
              [--select]
              [--set]
              [--soft-delete {false, true}]

Examples

Enable gallery to be shared to subscription or tenant

az sig update --resource-group myResourceGroup --gallery-name myGallery \
--permissions groups

Update gallery from private to community

az sig update -g myResourceGroup --gallery-name myGallery --permissions Community \
--publisher-uri myPublisherUri --publisher-email myPublisherEmail \
--eula myEula --public-name-prefix myPublicNamePrefix

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

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

Default value: []
--eula

Community gallery publisher eula.

--force-string

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

Default value: False
--permissions

This property allows you to specify the permission of sharing gallery.

Accepted values: Community, Groups, Private
--public-name-prefix

Community gallery public name prefix.

--publisher-email

Community gallery publisher contact email.

--publisher-uri

Community gallery publisher uri.

--remove

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

Default value: []
--select

The select expression to apply on the operation. "Permissions" Default value is None.

--set

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

Default value: []
--soft-delete
Deprecated

Argument '--soft-delete' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Enable soft-deletion for resources in this gallery, allowing them to be recovered within retention time.

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