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.
location	string	The location of the resource.
properties	object	The properties of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

list

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	The properties of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, labName, name	$expand, api-version	Get notification channel.
list	select	subscriptionId, resourceGroupName, labName	$expand, $filter, $top, $orderby, api-version	List notification channels in a given lab.
create_or_update	insert	subscriptionId, resourceGroupName, labName, name, data__properties	api-version	Create or replace an existing notification channel.
update	update	subscriptionId, resourceGroupName, labName, name	api-version	Allows modifying tags of notification channels. All other properties will be ignored.
delete	delete	subscriptionId, resourceGroupName, labName, name	api-version	Delete notification channel.
notify	exec	subscriptionId, resourceGroupName, labName, name	api-version	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
labName	string	The name of the lab.
name	string	The name of the notification channel.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The subscription ID.
$expand	string	Specify the $expand query. Example: 'properties($select=webHookUrl)'
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName')
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'
$top	integer (int32)	The maximum number of resources to return from the operation. Example: '$top=10'
api-version	string	Client API version.

SELECT examples

get

Get notification channel.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.notification_channels
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND labName = '{{ labName }}' -- required
AND name = '{{ name }}' -- required
AND $expand = '{{ $expand }}'
AND api-version = '{{ api-version }}'
;

list

List notification channels in a given lab.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.notification_channels
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND labName = '{{ labName }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create or replace an existing notification channel.

INSERT INTO azure.dev_test_labs.notification_channels (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
labName,
name,
api-version
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ labName }}',
'{{ name }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: notification_channels
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the notification_channels resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the notification_channels resource.
    - name: labName
      value: string
      description: Required parameter for the notification_channels resource.
    - name: name
      value: string
      description: Required parameter for the notification_channels resource.
    - name: location
      value: string
      description: |
        The location of the resource.
    - name: tags
      value: object
      description: |
        The tags of the resource.
    - name: properties
      value: object
      description: |
        The properties of the resource.
    - name: api-version
      value: string
      description: Client API version.

UPDATE examples

update

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

UPDATE azure.dev_test_labs.notification_channels
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND labName = '{{ labName }}' --required
AND name = '{{ name }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete notification channel.

DELETE FROM azure.dev_test_labs.notification_channels
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND labName = '{{ labName }}' --required
AND name = '{{ name }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

notify

Send notification to provided channel.

EXEC azure.dev_test_labs.notification_channels.notify 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@labName='{{ labName }}' --required, 
@name='{{ name }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"eventName": "{{ eventName }}", 
"jsonPayload": "{{ jsonPayload }}"
}'
;