galleries

Creates, updates, deletes, gets or lists a galleries resource.

Overview

Name	galleries
Type	Resource
Id	azure.compute.galleries

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The description of this Shared Image Gallery resource. This property is updatable.
identifier	object	Describes the gallery unique name.
identity	object	The identity of the gallery, if configured.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Deleting, Migrating)
sharingProfile	object	Profile for gallery sharing to subscription or tenant.
sharingStatus	object	Sharing status of current gallery.
softDeletePolicy	object	Contains information about the soft deletion policy of the gallery.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The description of this Shared Image Gallery resource. This property is updatable.
identifier	object	Describes the gallery unique name.
identity	object	The identity of the gallery, if configured.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Deleting, Migrating)
sharingProfile	object	Profile for gallery sharing to subscription or tenant.
sharingStatus	object	Sharing status of current gallery.
softDeletePolicy	object	Contains information about the soft deletion policy of the gallery.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	The description of this Shared Image Gallery resource. This property is updatable.
identifier	object	Describes the gallery unique name.
identity	object	The identity of the gallery, if configured.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Deleting, Migrating)
sharingProfile	object	Profile for gallery sharing to subscription or tenant.
sharingStatus	object	Sharing status of current gallery.
softDeletePolicy	object	Contains information about the soft deletion policy of the gallery.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, gallery_name, subscription_id	$select, $expand	Retrieves information about a Shared Image Gallery.
list_by_resource_group	select	resource_group_name, subscription_id		List galleries under a resource group.
list	select	subscription_id		List galleries under a subscription.
create_or_update	insert	resource_group_name, gallery_name, subscription_id, location		Create or update a Shared Image Gallery.
update	update	resource_group_name, gallery_name, subscription_id		Update a Shared Image Gallery.
create_or_update	replace	resource_group_name, gallery_name, subscription_id, location		Create or update a Shared Image Gallery.
delete	delete	resource_group_name, gallery_name, subscription_id		Delete a Shared Image Gallery.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
gallery_name	string	The name of the Shared Image Gallery. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	The expand query option to apply on the operation. "SharingProfile/Groups" Default value is None.
$select	string	The select expression to apply on the operation. "Permissions" Default value is None.

SELECT examples

get

Retrieves information about a Shared Image Gallery.

SELECT
id,
name,
description,
identifier,
identity,
location,
provisioningState,
sharingProfile,
sharingStatus,
softDeletePolicy,
systemData,
tags,
type
FROM azure.compute.galleries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $select = '{{ $select }}'
AND $expand = '{{ $expand }}'
;

list_by_resource_group

List galleries under a resource group.

SELECT
id,
name,
description,
identifier,
identity,
location,
provisioningState,
sharingProfile,
sharingStatus,
softDeletePolicy,
systemData,
tags,
type
FROM azure.compute.galleries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List galleries under a subscription.

SELECT
id,
name,
description,
identifier,
identity,
location,
provisioningState,
sharingProfile,
sharingStatus,
softDeletePolicy,
systemData,
tags,
type
FROM azure.compute.galleries
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Shared Image Gallery.

INSERT INTO azure.compute.galleries (
tags,
location,
properties,
identity,
resource_group_name,
gallery_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ gallery_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: galleries
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the galleries resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the galleries resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the galleries resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Describes the properties of a Shared Image Gallery.
    value:
      description: "{{ description }}"
      identifier:
        uniqueName: "{{ uniqueName }}"
      provisioningState: "{{ provisioningState }}"
      sharingProfile:
        permissions: "{{ permissions }}"
        groups:
          - type: "{{ type }}"
            ids: "{{ ids }}"
        communityGalleryInfo:
          publisherUri: "{{ publisherUri }}"
          publisherContact: "{{ publisherContact }}"
          eula: "{{ eula }}"
          publicNamePrefix: "{{ publicNamePrefix }}"
          communityGalleryEnabled: {{ communityGalleryEnabled }}
          publicNames:
            - "{{ publicNames }}"
      softDeletePolicy:
        isSoftDeleteEnabled: {{ isSoftDeleteEnabled }}
      sharingStatus:
        aggregatedState: "{{ aggregatedState }}"
        summary:
          - region: "{{ region }}"
            state: "{{ state }}"
            details: "{{ details }}"
  - name: identity
    description: |
      The identity of the gallery, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a Shared Image Gallery.

UPDATE azure.compute.galleries
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a Shared Image Gallery.

REPLACE azure.compute.galleries
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Shared Image Gallery.

DELETE FROM azure.compute.galleries
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;