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	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Shared Image Gallery.
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Shared Image Gallery.
tags	object	Resource tags
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Shared Image Gallery.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, galleryName	$select, $expand	Retrieves information about a Shared Image Gallery.
list_by_resource_group	select	subscriptionId, resourceGroupName		List galleries under a resource group.
list	select	subscriptionId		List galleries under a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, galleryName		Create or update a Shared Image Gallery.
update	update	subscriptionId, resourceGroupName, galleryName		Update a Shared Image Gallery.
delete	delete	subscriptionId, resourceGroupName, galleryName		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
galleryName	string	The name of the Shared Image Gallery to be deleted.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$expand	string	The expand query option to apply on the operation.
$select	string	The select expression to apply on the operation.

SELECT examples

get

Retrieves information about a Shared Image Gallery.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.galleries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND galleryName = '{{ galleryName }}' -- required
AND $select = '{{ $select }}'
AND $expand = '{{ $expand }}'
;

list_by_resource_group

List galleries under a resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.galleries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

List galleries under a subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.galleries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a Shared Image Gallery.

INSERT INTO azure.compute.galleries (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
galleryName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ galleryName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: galleries
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the galleries resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the galleries resource.
    - name: galleryName
      value: string
      description: Required parameter for the galleries resource.
    - name: properties
      value: object
      description: |
        Describes the properties of a Shared Image Gallery.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Update a Shared Image Gallery.

UPDATE azure.compute.galleries
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND galleryName = '{{ galleryName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete a Shared Image Gallery.

DELETE FROM azure.compute.galleries
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND galleryName = '{{ galleryName }}' --required
;