gallery_images

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

Overview

Name	gallery_images
Type	Resource
Id	azure.dev_test_labs.gallery_images

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
author	string	The author of the gallery image.
createdDate	string (date-time)	The creation date of the gallery image.
description	string	The description of the gallery image.
enabled	boolean	Indicates whether this gallery image is enabled.
icon	string	The icon of the gallery image.
imageReference	object	The image reference of the gallery image.
isPlanAuthorized	boolean	Indicates if the plan has been authorized for programmatic deployment.
location	string	The location of the resource.
planId	string	The third party plan that applies to this image.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resource_group_name, lab_name, subscription_id	$expand, $filter, $top, $orderby	List gallery images in a given lab.

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
lab_name	string	The name of the lab. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($select=author)'. Default value is None.
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

list

List gallery images in a given lab.

SELECT
id,
name,
author,
createdDate,
description,
enabled,
icon,
imageReference,
isPlanAuthorized,
location,
planId,
tags,
type
FROM azure.dev_test_labs.gallery_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;