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
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.
kind	string	The kind of trigger. Required. Default value is None.
provisioningState	string	Provisioning state of the resource. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled". (Creating, Updating, Succeeded, Failed, Deleting, Canceled)
status	object	Trigger status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_image_template

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.
kind	string	The kind of trigger. Required. Default value is None.
provisioningState	string	Provisioning state of the resource. Known values are: "Creating", "Updating", "Succeeded", "Failed", "Deleting", and "Canceled". (Creating, Updating, Succeeded, Failed, Deleting, Canceled)
status	object	Trigger status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, image_template_name, trigger_name, subscription_id		Get the specified trigger for the specified image template resource.
list_by_image_template	select	resource_group_name, image_template_name, subscription_id		List all triggers for the specified Image Template resource.
create_or_update	insert	resource_group_name, image_template_name, trigger_name, subscription_id		Create or update a trigger for the specified virtual machine image template.
create_or_update	replace	resource_group_name, image_template_name, trigger_name, subscription_id		Create or update a trigger for the specified virtual machine image template.
delete	delete	resource_group_name, image_template_name, trigger_name, subscription_id		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
image_template_name	string	The name of the image Template. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
trigger_name	string	The name of the trigger. Required.

SELECT examples

get

Get the specified trigger for the specified image template resource.

SELECT
id,
name,
kind,
provisioningState,
status,
systemData,
type
FROM azure.image_builder.triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND image_template_name = '{{ image_template_name }}' -- required
AND trigger_name = '{{ trigger_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_image_template

List all triggers for the specified Image Template resource.

SELECT
id,
name,
kind,
provisioningState,
status,
systemData,
type
FROM azure.image_builder.triggers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND image_template_name = '{{ image_template_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.image_builder.triggers (
properties,
resource_group_name,
image_template_name,
trigger_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ image_template_name }}',
'{{ trigger_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: triggers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the triggers resource.
  - name: image_template_name
    value: "{{ image_template_name }}"
    description: Required parameter for the triggers resource.
  - name: trigger_name
    value: "{{ trigger_name }}"
    description: Required parameter for the triggers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the triggers resource.
  - name: properties
    description: |
      The properties of a trigger.
    value:
      kind: "{{ kind }}"
      status:
        code: "{{ code }}"
        message: "{{ message }}"
        time: "{{ time }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

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

REPLACE azure.image_builder.triggers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND image_template_name = '{{ image_template_name }}' --required
AND trigger_name = '{{ trigger_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a trigger for the specified virtual machine image template.

DELETE FROM azure.image_builder.triggers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND image_template_name = '{{ image_template_name }}' --required
AND trigger_name = '{{ trigger_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;