triggers

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

Overview

Name	triggers
Type	Resource
Id	azure.image_builder.triggers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a trigger

list_by_image_template

Name	Datatype	Description
properties	object	The properties of a trigger

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, imageTemplateName, triggerName		Get the specified trigger for the specified image template resource
list_by_image_template	select	subscriptionId, resourceGroupName, imageTemplateName		List all triggers for the specified Image Template resource
create_or_update	insert	subscriptionId, resourceGroupName, imageTemplateName, triggerName		Create or update a trigger for the specified virtual machine image template
delete	delete	subscriptionId, resourceGroupName, imageTemplateName, triggerName		Delete a trigger for the specified virtual machine 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.
triggerName	string	The name of the trigger

SELECT examples

get

Get the specified trigger for the specified image template resource

SELECT
properties
FROM azure.image_builder.triggers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND imageTemplateName = '{{ imageTemplateName }}' -- required
AND triggerName = '{{ triggerName }}' -- required
;

list_by_image_template

List all triggers for the specified Image Template resource

SELECT
properties
FROM azure.image_builder.triggers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND imageTemplateName = '{{ imageTemplateName }}' -- required
;

INSERT examples

create_or_update

Create or update a trigger for the specified virtual machine image template

INSERT INTO azure.image_builder.triggers (
data__properties,
subscriptionId,
resourceGroupName,
imageTemplateName,
triggerName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ imageTemplateName }}',
'{{ triggerName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: triggers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the triggers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the triggers resource.
    - name: imageTemplateName
      value: string
      description: Required parameter for the triggers resource.
    - name: triggerName
      value: string
      description: Required parameter for the triggers resource.
    - name: properties
      value: object
      description: |
        The properties of a trigger

DELETE examples

delete

Delete a trigger for the specified virtual machine image template

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