virtual_machine_extension_images

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

Overview

Name	virtual_machine_extension_images
Type	Resource
Id	azure.compute.virtual_machine_extension_images

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.
computeRole	string	The type of role (IaaS or PaaS) this extension supports. Required.
handlerSchema	string	The schema defined by publisher, where extension consumers should provide settings in a matching schema. Required.
location	string	The geo-location where the resource lives. Required.
operatingSystem	string	The operating system this extension supports. Required.
supportsMultipleExtensions	boolean	Whether the handler can support multiple extensions.
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".
vmScaleSetEnabled	boolean	Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.

list_versions

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.
computeRole	string	The type of role (IaaS or PaaS) this extension supports. Required.
handlerSchema	string	The schema defined by publisher, where extension consumers should provide settings in a matching schema. Required.
location	string	The geo-location where the resource lives. Required.
operatingSystem	string	The operating system this extension supports. Required.
supportsMultipleExtensions	boolean	Whether the handler can support multiple extensions.
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".
vmScaleSetEnabled	boolean	Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.

list_types

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.
computeRole	string	The type of role (IaaS or PaaS) this extension supports. Required.
handlerSchema	string	The schema defined by publisher, where extension consumers should provide settings in a matching schema. Required.
location	string	The geo-location where the resource lives. Required.
operatingSystem	string	The operating system this extension supports. Required.
supportsMultipleExtensions	boolean	Whether the handler can support multiple extensions.
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".
vmScaleSetEnabled	boolean	Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, publisher_name, type_name, version, subscription_id		Gets a virtual machine extension image.
list_versions	select	location, publisher_name, type_name, subscription_id	$filter, $top, $orderby	Gets a list of virtual machine extension image versions.
list_types	select	location, publisher_name, subscription_id		Gets a list of virtual machine extension image types.

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
location	string	The location name. Required.
publisher_name	string	Required.
subscription_id	string
type_name	string	Required.
version	string	Required.
$filter	string	The filter 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 extension image.

SELECT
id,
name,
computeRole,
handlerSchema,
location,
operatingSystem,
supportsMultipleExtensions,
systemData,
tags,
type,
vmScaleSetEnabled
FROM azure.compute.virtual_machine_extension_images
WHERE location = '{{ location }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND type_name = '{{ type_name }}' -- required
AND version = '{{ version }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_versions

Gets a list of virtual machine extension image versions.

SELECT
id,
name,
computeRole,
handlerSchema,
location,
operatingSystem,
supportsMultipleExtensions,
systemData,
tags,
type,
vmScaleSetEnabled
FROM azure.compute.virtual_machine_extension_images
WHERE location = '{{ location }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND type_name = '{{ type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

list_types

Gets a list of virtual machine extension image types.

SELECT
id,
name,
computeRole,
handlerSchema,
location,
operatingSystem,
supportsMultipleExtensions,
systemData,
tags,
type,
vmScaleSetEnabled
FROM azure.compute.virtual_machine_extension_images
WHERE location = '{{ location }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;