az sig
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 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 |
Get 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 |
Place the CLI in a waiting state until a condition is met. |
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 wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az sig create
Create a shared image gallery.
az sig create --gallery-name
--resource-group
[--description]
[--eula]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--permissions {Community, Groups, Private}]
[--public-name-prefix]
[--publisher-contact --publisher-email]
[--publisher-uri]
[--soft-delete {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]
Examples
Create a shared image gallery
az sig create --resource-group MyResourceGroup --gallery-name MyGallery
Required Parameters
The name of the Shared Image Gallery to be deleted.
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.
The description of the gallery.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Community gallery publisher eula.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
Resource location When not specified, the location of the resource group will be used.
Property | Value |
---|---|
Parameter group: | Gallery Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
This property allows you to specify the permission of sharing gallery.
Property | Value |
---|---|
Parameter group: | SharingProfile Arguments |
Accepted values: | Community, Groups, Private |
Community gallery public name prefix.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
Community gallery publisher contact email.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
Community gallery publisher uri.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
Enable soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
Property | Value |
---|---|
Parameter group: | SoftDeletePolicy Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Gallery Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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.
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.
The description of the gallery.
Community gallery license agreement and privacy statement.
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.
Property | Value |
---|---|
Parameter group: | Sharing Profile Arguments |
Accepted values: | Community, Groups, Private |
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.
Property | Value |
---|---|
Accepted values: | false, true |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the Shared Image Gallery to be deleted.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az sig list
List galleries under a resource group.
az sig list [--max-items]
[--next-token]
[--resource-group]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az sig list-shared
List all shared galleries shared directly to your subscription or tenant.
az sig list-shared --location
[--max-items]
[--next-token]
[--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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
The query parameter to decide what shared galleries to fetch when doing listing operations. If not specified, list by subscription id.
Property | Value |
---|---|
Accepted values: | tenant |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az sig show
Retrieve information about a Shared Image Gallery.
az sig show [--gallery-name]
[--ids]
[--resource-group]
[--select {Permissions}]
[--sharing-groups {0, 1, f, false, n, no, t, true, y, yes}]
[--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.
The name of the Shared Image Gallery to be deleted.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The select expression to apply on the operation.
Property | Value |
---|---|
Accepted values: | Permissions |
The expand query option to query shared gallery groups.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
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 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az sig show-community
Get a community gallery by gallery public name.
az sig show-community [--ids]
[--location]
[--name --public-gallery-name]
[--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.
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 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The public name of the community gallery.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az sig show-community (image-gallery extension)
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The public name of community gallery.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az sig show-shared
Get a gallery that has been shared directly to your subscription or tenant.
az sig show-shared [--gallery-unique-name --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The unique name of the Shared Gallery.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az sig update
Update a share image gallery.
az sig update [--add]
[--eula]
[--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}]
[--permissions {Community, Groups, Private}]
[--public-name-prefix]
[--publisher-contact --publisher-email]
[--publisher-uri]
[--remove]
[--resource-group]
[--set]
[--soft-delete {0, 1, f, false, n, no, t, true, y, yes}]
[--subscription]
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
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Community gallery publisher eula.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
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 |
The name of the Shared Image Gallery to be deleted.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Resource location.
Property | Value |
---|---|
Parameter group: | Gallery Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
This property allows you to specify the permission of sharing gallery.
Property | Value |
---|---|
Parameter group: | SharingProfile Arguments |
Accepted values: | Community, Groups, Private |
Community gallery public name prefix.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
Community gallery publisher contact email.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
Community gallery publisher uri.
Property | Value |
---|---|
Parameter group: | CommunityGalleryInfo Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Enable soft-deletion for resources in this gallery, allowing them to be recovered within retention time.
Property | Value |
---|---|
Parameter group: | SoftDeletePolicy Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
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 |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az sig wait
Place the CLI in a waiting state until a condition is met.
az sig wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand {SharingProfile/Groups}]
[--gallery-name]
[--ids]
[--interval]
[--resource-group]
[--select {Permissions}]
[--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.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
The expand query option to apply on the operation.
Property | Value |
---|---|
Accepted values: | SharingProfile/Groups |
The name of the Shared Image Gallery to be deleted.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The select expression to apply on the operation.
Property | Value |
---|---|
Accepted values: | Permissions |
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 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |