virtual_machine_images

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

Overview

Name	virtual_machine_images
Type	Resource
Id	azure.compute.virtual_machine_images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The name of the resource.
extendedLocation	object	The extended location of the Virtual Machine.
location	string	The supported Azure location of the resource.
properties	object	Describes the properties of a Virtual Machine Image.
tags	object	Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.

list_by_edge_zone

Name	Datatype	Description
id	string	Resource Id
name	string	The name of the resource.
extendedLocation	object	The extended location of the Virtual Machine.
location	string	The supported Azure location of the resource.
tags	object	Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, publisherName, offer, skus, version, subscriptionId		Gets a virtual machine image.
list_by_edge_zone	select	location, edgeZone, subscriptionId		Gets a list of all virtual machine image versions for the specified edge zone
list	exec	location, publisherName, offer, skus, subscriptionId	$expand, $top, $orderby	Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.

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
edgeZone	string	The name of the edge zone.
location	string	The name of a supported Azure region.
offer	string	A valid image publisher offer.
publisherName	string	A valid image publisher.
skus	string	A valid image SKU.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
version	string	A valid image SKU version.
$expand	string	The expand expression to apply on the operation.
$orderby	string
$top	integer (int32)

SELECT examples

get

Gets a virtual machine image.

SELECT
name,
extendedLocation,
location,
properties,
tags
FROM azure.compute.virtual_machine_images
WHERE location = '{{ location }}' -- required
AND publisherName = '{{ publisherName }}' -- required
AND offer = '{{ offer }}' -- required
AND skus = '{{ skus }}' -- required
AND version = '{{ version }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_edge_zone

Gets a list of all virtual machine image versions for the specified edge zone

SELECT
id,
name,
extendedLocation,
location,
tags
FROM azure.compute.virtual_machine_images
WHERE location = '{{ location }}' -- required
AND edgeZone = '{{ edgeZone }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

Lifecycle Methods

list

Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.

EXEC azure.compute.virtual_machine_images.list 
@location='{{ location }}' --required, 
@publisherName='{{ publisherName }}' --required, 
@offer='{{ offer }}' --required, 
@skus='{{ skus }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@$expand='{{ $expand }}', 
@$top='{{ $top }}', 
@$orderby='{{ $orderby }}'
;