az sig

Reference

Manage shared image gallery.

Commands

az sig create	Create a shared image gallery.
az sig delete	Delete a Shared Image Gallery.
az sig gallery-application	Manage gallery application.
az sig gallery-application create	Create a gallery Application Definition.
az sig gallery-application delete	Delete a gallery Application.
az sig gallery-application list	List gallery Application Definitions in a gallery.
az sig gallery-application show	Retrieves information about a gallery Application Definition.
az sig gallery-application update	Update a gallery Application Definition.
az sig gallery-application version	Manage gallery application version.
az sig gallery-application version create	Create a gallery Application Version.
az sig gallery-application version delete	Delete a gallery Application Version.
az sig gallery-application version list	List gallery Application Versions in a gallery Application Definition.
az sig gallery-application version show	Retrieves information about a gallery Application Version.
az sig gallery-application version update	Update a gallery Application Version.
az sig gallery-application wait	Place the CLI in a waiting state until a condition of the sig gallery-application is met.
az sig image-definition	Manage shared gallery image with VM.
az sig image-definition create	Create a gallery image definition.
az sig image-definition delete	Delete a gallery image.
az sig image-definition list	List gallery image definitions in a gallery.
az sig image-definition list-community	List VM Image definitions in a gallery community (preview).
az sig image-definition list-shared	List VM Image definitions in a gallery shared directly to your subscription or tenant (preview).
az sig image-definition show	Retrieves information about a gallery image definition.
az sig image-definition show-community	Get an image in a gallery community (preview).
az sig image-definition show-shared	Get a shared gallery image (preview).
az sig image-definition update	Update a VM Image definition.
az sig image-version	Manage shared gallery image version with VM.
az sig image-version create	Create a new image version.
az sig image-version delete	Delete a gallery image version.
az sig image-version list	List gallery image versions in a gallery image definition.
az sig image-version list-community	List VM Image Versions in a gallery community (preview).
az sig image-version list-shared	List VM Image Versions in a gallery shared directly to your subscription or tenant (preview).
az sig image-version show	Retrieves information about a gallery image version.
az sig image-version show-community	Get an image version in a gallery community (preview).
az sig image-version show-shared	Get an image version in a gallery shared directly to your subscription or tenant (preview).
az sig image-version update	Update a share image version.
az sig image-version wait	Wait for image version related operation.
az sig list	List share image galleries.
az sig list-shared	List all galleries shared directly to your subscription or tenant (preview).
az sig share	Manage gallery sharing profile.
az sig share add	Share gallery with subscriptions and tenants.
az sig share enable-community	Allow to share gallery to the community.
az sig share remove	Stop sharing gallery with a subscription or tenant.
az sig share reset	Disable gallery from being shared with subscription or tenant.
az sig share wait	Place the CLI in a waiting state until a condition of a shared gallery is met.
az sig show	Retrieves information about a Shared Image Gallery.
az sig show-community	Get a gallery that has been community (preview).
az sig show-shared	Get a gallery that has been shared directly to your subscription or tenant (preview).
az sig update	Update a share image gallery.

az sig create

Create a shared image gallery.

az sig create --gallery-name
              --resource-group
              [--description]
              [--location]
              [--permissions {Groups, Private}]
              [--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.

--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: Groups, Private

--soft-delete

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.

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

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

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.

--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 share image galleries.

az sig list [--resource-group]

Examples

List shared galleries by subscription id.

az sig list-shared --location myLocation

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.

--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 galleries shared directly to your subscription or tenant (preview).

List all galleries shared directly to your subscription or tenant (private preview feature, please contact shared image gallery team by email sigpmdev@microsoft.com to register for preview if you're interested in using this feature).

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

Examples

List galleries shared directly to your subscription in a given location

az sig list-shared --location myLocation

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

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

Retrieves information about a Shared Image Gallery.

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

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.

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.

--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 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 --location
                      --public-gallery-name

Examples

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

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

Required Parameters

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

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.

--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 (preview).

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

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

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 galleryUniqueName --location myLocation

Optional Parameters

--gallery-unique-name

The unique name of the Shared Gallery.

--ids

--location -l

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

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.

--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]
              [--force-string]
              [--permissions {Groups, Private}]
              [--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

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

--force-string

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

--permissions

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

accepted values: Groups, Private

--remove

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

--select

The select expression to apply on the operation.

--set

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

--soft-delete

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.

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

Is this page helpful?

Commands

az sig create

Examples

Required Parameters

Optional Parameters

az sig delete

Required Parameters

az sig list

Examples

Optional Parameters

az sig list-shared

Examples

Required Parameters

Optional Parameters

az sig show

Optional Parameters

az sig show-community

Examples

Required Parameters

az sig show-shared

Examples

Optional Parameters

az sig update

Examples

Required Parameters

Optional Parameters

الملاحظات