Share via

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.

Commands

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

az sig share add

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]

Examples

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--gallery-name -r

The name of the Shared Image Gallery.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

A list of subscription ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--tenant-ids

A list of tenant ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sig share enable-community

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]

Examples

Allow to share gallery to the community

az sig share enable-community --resource-group MyResourceGroup --gallery-name MyGallery

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--gallery-name -r

The name of the Shared Image Gallery.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

A list of subscription ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--tenant-ids

A list of tenant ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

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

Allow to share gallery to the community.

az sig share enable-community [--gallery-name]
                              [--ids]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]
                              [--subscription-ids]
                              [--tenant-ids]

Examples

Allow to share gallery to the community

az sig share enable-community --resource-group MyResourceGroup --gallery-name MyGallery

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--gallery-name -r

The name of the Shared Image Gallery.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

A list of subscription ids to share the gallery.

--tenant-ids

A list of tenant ids to share the gallery.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sig share remove

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]

Examples

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--gallery-name -r

The name of the Shared Image Gallery.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

A list of subscription ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--tenant-ids

A list of tenant ids to share the gallery with. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sig share reset

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]

Examples

Reset sharing profile of a gallery.

az sig share reset --resource-group MyResourceGroup --gallery-name MyGallery

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--gallery-name -r

The name of the Shared Image Gallery.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sig share wait

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]

Examples

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--expand

The expand query option to apply on the operation.

Property Value
Accepted values: SharingProfile/Groups
--gallery-name -r

The name of the Shared Image Gallery to be deleted.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--select

The select expression to apply on the operation.

Property Value
Accepted values: Permissions
--subscription

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

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False