az sig share
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 gallery sharing profile.
Name | Description | Type | Status |
---|---|---|---|
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 |
Share gallery with subscriptions and tenants.
az sig share add [--gallery-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--subscription-ids]
[--tenant-ids]
Share entire gallery with all members of a subscription and/or tenant.
az sig share add --resource-group MyResourceGroup --gallery-name MyGallery \
--subscription-ids subId1 subId2 --tenant-ids tenantId1 tenantId2
The name of the Shared Image 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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
A list of subscription ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
A list of tenant ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
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.
Allow to share gallery to the community.
az sig share enable-community [--gallery-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--subscription-ids]
[--tenant-ids]
Allow to share gallery to the community
az sig share enable-community --resource-group MyResourceGroup --gallery-name MyGallery
The name of the Shared Image 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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
A list of subscription ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
A list of tenant ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
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.
Allow to share gallery to the community.
az sig share enable-community [--gallery-name]
[--ids]
[--no-wait]
[--resource-group]
[--subscription]
[--subscription-ids]
[--tenant-ids]
Allow to share gallery to the community
az sig share enable-community --resource-group MyResourceGroup --gallery-name MyGallery
The name of the Shared Image 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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
A list of subscription ids to share the gallery.
A list of tenant ids to share the gallery.
Global Parameters
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.
Stop sharing gallery with a subscription or tenant.
az sig share remove [--gallery-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--subscription-ids]
[--tenant-ids]
Stop sharing with a subscription or tenant ID
az sig share remove --resource-group MyResourceGroup --gallery-name MyGallery \
--subscription-ids subId1 subId2 --tenant-ids tenantId1 tenantId2
The name of the Shared Image 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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
A list of subscription ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
A list of tenant ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
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.
Disable gallery from being shared with subscription or tenant.
az sig share reset [--gallery-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Reset sharing profile of a gallery.
az sig share reset --resource-group MyResourceGroup --gallery-name MyGallery
The name of the Shared Image 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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
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.
Place the CLI in a waiting state until a condition of a shared gallery is met.
az sig share wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand {SharingProfile/Groups}]
[--gallery-name]
[--ids]
[--interval]
[--resource-group]
[--select {Permissions}]
[--subscription]
[--timeout]
[--updated]
Place the CLI in a waiting state until the gallery sharing object is updated.
az sig share wait --updated --resource-group MyResourceGroup --gallery-name Gallery
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
The expand query option to apply on the operation.
The name of the Shared Image Gallery to be deleted.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The select expression to apply on the operation.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: