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

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
createdDate	string (date-time)	The creation date of the notification channel.
description	string	Description of notification.
emailRecipient	string	The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
events	array	The list of event for which this notification is enabled.
location	string	The location of the resource.
notificationLocale	string	The locale to use when sending a notification (fallback for unsupported languages is EN).
provisioningState	string	The provisioning status of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
webHookUrl	string	The webhook URL to send notifications to.

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
createdDate	string (date-time)	The creation date of the notification channel.
description	string	Description of notification.
emailRecipient	string	The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
events	array	The list of event for which this notification is enabled.
location	string	The location of the resource.
notificationLocale	string	The locale to use when sending a notification (fallback for unsupported languages is EN).
provisioningState	string	The provisioning status of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
webHookUrl	string	The webhook URL to send notifications to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, name, subscription_id	$expand	Get notification channel.
list	select	resource_group_name, lab_name, subscription_id	$expand, $filter, $top, $orderby	List notification channels in a given lab.
create_or_update	insert	resource_group_name, lab_name, name, subscription_id		Create or replace an existing notification channel.
update	update	resource_group_name, lab_name, name, subscription_id		Allows modifying tags of notification channels. All other properties will be ignored.
create_or_update	replace	resource_group_name, lab_name, name, subscription_id		Create or replace an existing notification channel.
delete	delete	resource_group_name, lab_name, name, subscription_id		Delete notification channel.
notify	exec	resource_group_name, lab_name, name, subscription_id		Send notification to provided channel.

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
lab_name	string	The name of the lab. Required.
name	string	The name of the notification channel. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($select=webHookUrl)'. Default value is None.
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get notification channel.

SELECT
id,
name,
createdDate,
description,
emailRecipient,
events,
location,
notificationLocale,
provisioningState,
tags,
type,
uniqueIdentifier,
webHookUrl
FROM azure.dev_test_labs.notification_channels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List notification channels in a given lab.

SELECT
id,
name,
createdDate,
description,
emailRecipient,
events,
location,
notificationLocale,
provisioningState,
tags,
type,
uniqueIdentifier,
webHookUrl
FROM azure.dev_test_labs.notification_channels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or replace an existing notification channel.

INSERT INTO azure.dev_test_labs.notification_channels (
location,
tags,
properties,
resource_group_name,
lab_name,
name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: notification_channels
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the notification_channels resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the notification_channels resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the notification_channels resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the notification_channels resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: properties
    value:
      webHookUrl: "{{ webHookUrl }}"
      emailRecipient: "{{ emailRecipient }}"
      notificationLocale: "{{ notificationLocale }}"
      description: "{{ description }}"
      events:
        - eventName: "{{ eventName }}"

UPDATE examples

update

Allows modifying tags of notification channels. All other properties will be ignored.

UPDATE azure.dev_test_labs.notification_channels
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or replace an existing notification channel.

REPLACE azure.dev_test_labs.notification_channels
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete notification channel.

DELETE FROM azure.dev_test_labs.notification_channels
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

notify

Send notification to provided channel.

EXEC azure.dev_test_labs.notification_channels.notify 
@resource_group_name='{{ resource_group_name }}' --required, 
@lab_name='{{ lab_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;