notification_channels

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

Overview

Name	notification_channels
Type	Resource
Id	azure.dev_test_labs.notification_channels

Fields

vw_notification_channels

Name	Datatype	Description
id	text	The identifier of the resource.
name	text	The name of the resource.
description	text	field from the properties object
created_date	text	field from the properties object
email_recipient	text	field from the properties object
events	text	field from the properties object
labName	text	field from the properties object
location	text	The location of the resource.
notification_locale	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	The tags of the resource.
type	text	The type of the resource.
unique_identifier	text	field from the properties object
web_hook_url	text	field from the properties object

notification_channels

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
location	string	The location of the resource.
properties	object	Properties of a schedule.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	labName, name, resourceGroupName, subscriptionId	Get notification channel.
list	SELECT	labName, resourceGroupName, subscriptionId	List notification channels in a given lab.
create_or_update	INSERT	labName, name, resourceGroupName, subscriptionId, data__properties	Create or replace an existing notification channel.
delete	DELETE	labName, name, resourceGroupName, subscriptionId	Delete notification channel.
update	UPDATE	labName, name, resourceGroupName, subscriptionId	Allows modifying tags of notification channels. All other properties will be ignored.
notify	EXEC	labName, name, resourceGroupName, subscriptionId	Send notification to provided channel.

SELECT examples

List notification channels in a given lab.

vw_notification_channels

SELECT
id,
name,
description,
created_date,
email_recipient,
events,
labName,
location,
notification_locale,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
type,
unique_identifier,
web_hook_url
FROM azure.dev_test_labs.vw_notification_channels
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

notification_channels

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.notification_channels
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.dev_test_labs.notification_channels (
labName,
name,
resourceGroupName,
subscriptionId,
data__properties,
location,
tags,
properties
)
SELECT 
'{{ labName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: webHookUrl
          value: string
        - name: emailRecipient
          value: string
        - name: notificationLocale
          value: string
        - name: description
          value: string
        - name: events
          value:
            - - name: eventName
                value: string
        - name: createdDate
          value: string
        - name: provisioningState
          value: string
        - name: uniqueIdentifier
          value: string

UPDATE example

Updates a notification_channels resource.

/*+ update */
UPDATE azure.dev_test_labs.notification_channels
SET 
tags = '{{ tags }}'
WHERE 
labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified notification_channels resource.

/*+ delete */
DELETE FROM azure.dev_test_labs.notification_channels
WHERE labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';