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
id	string	Resource Id.
name	string	The name of the resource. Required.
architecture	string	Specifies the Architecture Type. Known values are: "x64" and "Arm64". (x64, Arm64)
automaticOSUpgradeProperties	object	Describes automatic OS upgrade properties on the image.
dataDiskImages	array	The list of data disk images information.
disallowed	object	Specifies disallowed configuration for the VirtualMachine created from the image.
extendedLocation	object	The extended location of the Virtual Machine.
features	array	:vartype features: list[~azure.mgmt.compute.models.VirtualMachineImageFeature]
hyperVGeneration	string	Specifies the HyperVGeneration Type. Known values are: "V1" and "V2". (V1, V2)
imageDeprecationStatus	object	Describes image deprecation status properties on the image.
location	string	The supported Azure location of the resource. Required.
osDiskImage	object	Contains the os disk image information.
plan	object	Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
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_with_properties

Name	Datatype	Description
id	string	Resource Id.
name	string	The name of the resource. Required.
architecture	string	Specifies the Architecture Type. Known values are: "x64" and "Arm64". (x64, Arm64)
automaticOSUpgradeProperties	object	Describes automatic OS upgrade properties on the image.
dataDiskImages	array	The list of data disk images information.
disallowed	object	Specifies disallowed configuration for the VirtualMachine created from the image.
extendedLocation	object	The extended location of the Virtual Machine.
features	array	:vartype features: list[~azure.mgmt.compute.models.VirtualMachineImageFeature]
hyperVGeneration	string	Specifies the HyperVGeneration Type. Known values are: "V1" and "V2". (V1, V2)
imageDeprecationStatus	object	Describes image deprecation status properties on the image.
location	string	The supported Azure location of the resource. Required.
osDiskImage	object	Contains the os disk image information.
plan	object	Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
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

Name	Datatype	Description
id	string	Resource Id.
name	string	The name of the resource. Required.
extendedLocation	object	The extended location of the Virtual Machine.
location	string	The supported Azure location of the resource. Required.
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_skus

Name	Datatype	Description
id	string	Resource Id.
name	string	The name of the resource. Required.
extendedLocation	object	The extended location of the Virtual Machine.
location	string	The supported Azure location of the resource. Required.
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. Required.
extendedLocation	object	The extended location of the Virtual Machine.
location	string	The supported Azure location of the resource. Required.
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_offers

Name	Datatype	Description
id	string	Resource Id.
name	string	The name of the resource. Required.
extendedLocation	object	The extended location of the Virtual Machine.
location	string	The supported Azure location of the resource. Required.
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_publishers

Name	Datatype	Description
id	string	Resource Id.
name	string	The name of the resource. Required.
extendedLocation	object	The extended location of the Virtual Machine.
location	string	The supported Azure location of the resource. Required.
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, publisher_name, offer, skus, version, subscription_id		Gets a virtual machine image.
list_with_properties	select	location, publisher_name, offer, skus, subscription_id, $expand	$top, $orderby	list_with_properties.
list	select	location, publisher_name, offer, skus, subscription_id	$expand, $top, $orderby	Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
list_skus	select	location, publisher_name, offer, subscription_id		Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.
list_by_edge_zone	select	location, edge_zone, subscription_id		Gets a list of all virtual machine image versions for the specified edge zone.
list_offers	select	location, publisher_name, subscription_id		Gets a list of virtual machine image offers for the specified location and publisher.
list_publishers	select	location, subscription_id		Gets a list of virtual machine image publishers for the specified Azure location.

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
$expand	string	The expand expression to apply on the operation. Required.
edge_zone	string	The name of the edge zone. Required.
location	string	The location name. Required.
offer	string	A valid image publisher offer. Required.
publisher_name	string	A valid image publisher. Required.
skus	string	A valid image SKU. Required.
subscription_id	string
version	string	A valid image SKU version. Required.
$expand	string	The expand expression to apply on the operation. Default value is None.
$orderby	string	Default value is None.
$top	integer	Default value is None.

SELECT examples

get

Gets a virtual machine image.

SELECT
id,
name,
architecture,
automaticOSUpgradeProperties,
dataDiskImages,
disallowed,
extendedLocation,
features,
hyperVGeneration,
imageDeprecationStatus,
location,
osDiskImage,
plan,
tags
FROM azure.compute.virtual_machine_images
WHERE location = '{{ location }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND offer = '{{ offer }}' -- required
AND skus = '{{ skus }}' -- required
AND version = '{{ version }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_with_properties

list_with_properties.

SELECT
id,
name,
architecture,
automaticOSUpgradeProperties,
dataDiskImages,
disallowed,
extendedLocation,
features,
hyperVGeneration,
imageDeprecationStatus,
location,
osDiskImage,
plan,
tags
FROM azure.compute.virtual_machine_images
WHERE location = '{{ location }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND offer = '{{ offer }}' -- required
AND skus = '{{ skus }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}' -- required
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

list

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

SELECT
id,
name,
extendedLocation,
location,
tags
FROM azure.compute.virtual_machine_images
WHERE location = '{{ location }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND offer = '{{ offer }}' -- required
AND skus = '{{ skus }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

list_skus

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

SELECT
id,
name,
extendedLocation,
location,
tags
FROM azure.compute.virtual_machine_images
WHERE location = '{{ location }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND offer = '{{ offer }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 edge_zone = '{{ edge_zone }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_offers

Gets a list of virtual machine image offers for the specified location and publisher.

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

list_publishers

Gets a list of virtual machine image publishers for the specified Azure location.

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