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

vw_virtual_machine_image_templates

Name	Datatype	Description
auto_run	text	field from the properties object
build_timeout_in_minutes	text	field from the properties object
customize	text	field from the properties object
distribute	text	field from the properties object
error_handling	text	field from the properties object
exact_staging_resource_group	text	field from the properties object
identity	text	Identity for the image template.
imageTemplateName	text	field from the properties object
last_run_status	text	field from the properties object
location	text	The geo-location where the resource lives
managed_resource_tags	text	field from the properties object
optimize	text	field from the properties object
provisioning_error	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
source	text	field from the properties object
staging_resource_group	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
validate	text	field from the properties object
vm_profile	text	field from the properties object

virtual_machine_image_templates

Name	Datatype	Description
identity	object	Identity for the image template.
location	string	The geo-location where the resource lives
properties	object	Describes the properties of an image template
tags	object	Resource tags.

Methods

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

SELECT examples

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

vw_virtual_machine_image_templates

SELECT
auto_run,
build_timeout_in_minutes,
customize,
distribute,
error_handling,
exact_staging_resource_group,
identity,
imageTemplateName,
last_run_status,
location,
managed_resource_tags,
optimize,
provisioning_error,
provisioning_state,
resourceGroupName,
source,
staging_resource_group,
subscriptionId,
tags,
validate,
vm_profile
FROM azure.image_builder.vw_virtual_machine_image_templates
WHERE subscriptionId = '{{ subscriptionId }}';

virtual_machine_image_templates

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

INSERT example

Use the following StackQL query and manifest file to create a new virtual_machine_image_templates resource.

All Properties

/*+ create */
INSERT INTO azure.image_builder.virtual_machine_image_templates (
imageTemplateName,
resourceGroupName,
subscriptionId,
data__identity,
properties,
identity,
tags,
location
)
SELECT 
'{{ imageTemplateName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__identity }}',
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: source
          value:
            - name: type
              value: string
        - name: customize
          value:
            - - name: type
                value: string
              - name: name
                value: string
        - name: optimize
          value:
            - name: vmBoot
              value:
                - name: state
                  value: string
        - name: validate
          value:
            - name: continueDistributeOnFailure
              value: boolean
            - name: sourceValidationOnly
              value: boolean
            - name: inVMValidations
              value:
                - - name: type
                    value: string
                  - name: name
                    value: string
        - name: distribute
          value:
            - - name: type
                value: string
              - name: runOutputName
                value: string
              - name: artifactTags
                value: object
        - name: errorHandling
          value:
            - name: onCustomizerError
              value: []
        - name: provisioningState
          value: []
        - name: provisioningError
          value:
            - name: provisioningErrorCode
              value: string
            - name: message
              value: string
        - name: lastRunStatus
          value:
            - name: startTime
              value: string
            - name: endTime
              value: string
            - name: runState
              value: string
            - name: runSubState
              value: string
            - name: message
              value: string
        - name: buildTimeoutInMinutes
          value: integer
        - name: vmProfile
          value:
            - name: vmSize
              value: string
            - name: osDiskSizeGB
              value: integer
            - name: userAssignedIdentities
              value:
                - string
            - name: vnetConfig
              value:
                - name: subnetId
                  value: string
                - name: containerInstanceSubnetId
                  value: string
                - name: proxyVmSize
                  value: string
        - name: stagingResourceGroup
          value: string
        - name: exactStagingResourceGroup
          value: string
        - name: autoRun
          value:
            - name: state
              value: string
        - name: managedResourceTags
          value: object
    - name: identity
      value:
        - name: type
          value: string
        - name: userAssignedIdentities
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a virtual_machine_image_templates resource.

/*+ update */
UPDATE azure.image_builder.virtual_machine_image_templates
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
imageTemplateName = '{{ imageTemplateName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified virtual_machine_image_templates resource.

/*+ delete */
DELETE FROM azure.image_builder.virtual_machine_image_templates
WHERE imageTemplateName = '{{ imageTemplateName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';