virtual_machine_image_templates

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

Overview

Name	virtual_machine_image_templates
Type	Resource
Id	azure.image_builder.virtual_machine_image_templates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	The identity of the image template, if configured.
location	string	The geo-location where the resource lives
properties	object	The properties of the image template
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	The identity of the image template, if configured.
location	string	The geo-location where the resource lives
properties	object	The properties of the image template
tags	object	Resource tags.

list

Name	Datatype	Description
identity	object	The identity of the image template, if configured.
location	string	The geo-location where the resource lives
properties	object	The properties of the image template
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, imageTemplateName		Get information about a virtual machine image template
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets information about the VM image templates associated with the specified resource group.
list	select	subscriptionId		Gets information about the VM image templates associated with the subscription.
create_or_update	insert	subscriptionId, resourceGroupName, imageTemplateName, data__identity		Create or update a virtual machine image template
update	update	subscriptionId, resourceGroupName, imageTemplateName		Update the tags for this Virtual Machine Image Template
delete	delete	subscriptionId, resourceGroupName, imageTemplateName		Delete a virtual machine image template
run	exec	subscriptionId, resourceGroupName, imageTemplateName		Create artifacts from a existing image template
cancel	exec	subscriptionId, resourceGroupName, imageTemplateName		Cancel the long running image build based on the image template

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
imageTemplateName	string	The name of the image Template
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.

SELECT examples

get

Get information about a virtual machine image template

SELECT
identity,
location,
properties,
tags
FROM azure.image_builder.virtual_machine_image_templates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND imageTemplateName = '{{ imageTemplateName }}' -- required
;

list_by_resource_group

Gets information about the VM image templates associated with the specified resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.image_builder.virtual_machine_image_templates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets information about the VM image templates associated with the subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.image_builder.virtual_machine_image_templates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a virtual machine image template

INSERT INTO azure.image_builder.virtual_machine_image_templates (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
imageTemplateName
)
SELECT 
'{{ properties }}',
'{{ identity }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ imageTemplateName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: virtual_machine_image_templates
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the virtual_machine_image_templates resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_machine_image_templates resource.
    - name: imageTemplateName
      value: string
      description: Required parameter for the virtual_machine_image_templates resource.
    - name: properties
      value: object
      description: |
        The properties of the image template
    - name: identity
      value: object
      description: |
        The identity of the image template, if configured.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update the tags for this Virtual Machine Image Template

UPDATE azure.image_builder.virtual_machine_image_templates
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND imageTemplateName = '{{ imageTemplateName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Delete a virtual machine image template

DELETE FROM azure.image_builder.virtual_machine_image_templates
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND imageTemplateName = '{{ imageTemplateName }}' --required
;

Lifecycle Methods

run

Create artifacts from a existing image template

EXEC azure.image_builder.virtual_machine_image_templates.run 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@imageTemplateName='{{ imageTemplateName }}' --required
;

cancel

Cancel the long running image build based on the image template

EXEC azure.image_builder.virtual_machine_image_templates.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@imageTemplateName='{{ imageTemplateName }}' --required
;