az sig
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 |
Get 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. |
az sig gallery-application version show |
Get information about a gallery application version. |
az sig gallery-application version update |
Update a gallery Application Version. |
az sig gallery-application version wait |
Place the CLI in a waiting state until a condition is met. |
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. |
az sig image-definition list-shared |
List VM Image definitions in a gallery shared directly to your subscription or tenant. |
az sig image-definition show |
Retrieves information about a gallery image definition. |
az sig image-definition show-community |
Get a community gallery image. |
az sig image-definition show-shared |
Get a shared gallery image. |
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. |
az sig image-version list-shared |
List VM Image Versions in a gallery shared directly to your subscription or tenant. |
az sig image-version show |
Retrieves information about a gallery image version. |
az sig image-version show-community |
Get a community gallery image version. |
az sig image-version show-shared |
Get an image version in a gallery shared directly to your subscription or tenant. |
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-community |
List all community galleries shared directly to your subscription or tenant. |
az sig list-shared |
List all shared galleries shared directly to your subscription or tenant. |
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 |
Retrieve information about a Shared Image Gallery. |
az sig show-community |
Get a community gallery by gallery public name. |
az sig show-shared |
Get a gallery that has been shared directly to your subscription or tenant. |
az sig update |
Update a share image gallery. |
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The description of the gallery.
Community gallery publisher eula.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
This property allows you to specify the permission of sharing gallery.
Community gallery public name prefix.
Community gallery publisher contact email.
Community gallery publisher uri.
Enable soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az sig list-community
List all community galleries shared directly to your subscription or tenant.
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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
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 nextMarker in result when specified.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az sig list-shared
List all shared galleries shared directly to your subscription or tenant.
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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Optional Parameters
The query parameter to decide what shared galleries to fetch when doing listing operations. If not specified, list by subscription id.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The select expression to apply on the operation.
The expand query option to query shared gallery groups.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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]
[--public-gallery-name]
[--subscription]
Optional Parameters
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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The public name of community gallery.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
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 galleryUniqueName --location myLocation
Optional Parameters
The unique name of the Shared Gallery.
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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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>.
Community gallery publisher eula.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
This property allows you to specify the permission of sharing gallery.
Community gallery public name prefix.
Community gallery publisher contact email.
Community gallery publisher uri.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
The select expression to apply on the operation. "Permissions" Default value is None.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Enable soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Submit and view feedback for