Microsoft.DevTestLab labs/notificationchannels

Bicep resource definition

The labs/notificationchannels resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevTestLab/labs/notificationchannels resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevTestLab/labs/notificationchannels@2018-09-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    emailRecipient: 'string'
    events: [
      {
        eventName: 'string'
      }
    ]
    notificationLocale: 'string'
    webHookUrl: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevTestLab/labs/notificationchannels

Name Description Value
location The geo-location where the resource lives string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: labs
properties The properties of the resource. NotificationChannelProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

Event

Name Description Value
eventName The event type for which this notification is enabled (i.e. AutoShutdown, Cost) 'AutoShutdown'
'Cost'

NotificationChannelProperties

Name Description Value
description Description of notification. string
emailRecipient The email recipient to send notifications to (can be a list of semi-colon separated email addresses). string
events The list of event for which this notification is enabled. Event[]
notificationLocale The locale to use when sending a notification (fallback for unsupported languages is EN). string
webHookUrl The webhook URL to send notifications to. string

NotificationChannelTags

Name Description Value

ARM template resource definition

The labs/notificationchannels resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevTestLab/labs/notificationchannels resource, add the following JSON to your template.

{
  "type": "Microsoft.DevTestLab/labs/notificationchannels",
  "apiVersion": "2018-09-15",
  "name": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "emailRecipient": "string",
    "events": [
      {
        "eventName": "string"
      }
    ],
    "notificationLocale": "string",
    "webHookUrl": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevTestLab/labs/notificationchannels

Name Description Value
apiVersion The api version '2018-09-15'
location The geo-location where the resource lives string
name The resource name string (required)
properties The properties of the resource. NotificationChannelProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevTestLab/labs/notificationchannels'

Event

Name Description Value
eventName The event type for which this notification is enabled (i.e. AutoShutdown, Cost) 'AutoShutdown'
'Cost'

NotificationChannelProperties

Name Description Value
description Description of notification. string
emailRecipient The email recipient to send notifications to (can be a list of semi-colon separated email addresses). string
events The list of event for which this notification is enabled. Event[]
notificationLocale The locale to use when sending a notification (fallback for unsupported languages is EN). string
webHookUrl The webhook URL to send notifications to. string

NotificationChannelTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The labs/notificationchannels resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DevTestLab/labs/notificationchannels resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevTestLab/labs/notificationchannels@2018-09-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      description = "string"
      emailRecipient = "string"
      events = [
        {
          eventName = "string"
        }
      ]
      notificationLocale = "string"
      webHookUrl = "string"
    }
  }
}

Property Values

Microsoft.DevTestLab/labs/notificationchannels

Name Description Value
location The geo-location where the resource lives string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: labs
properties The properties of the resource. NotificationChannelProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevTestLab/labs/notificationchannels@2018-09-15"

Event

Name Description Value
eventName The event type for which this notification is enabled (i.e. AutoShutdown, Cost) 'AutoShutdown'
'Cost'

NotificationChannelProperties

Name Description Value
description Description of notification. string
emailRecipient The email recipient to send notifications to (can be a list of semi-colon separated email addresses). string
events The list of event for which this notification is enabled. Event[]
notificationLocale The locale to use when sending a notification (fallback for unsupported languages is EN). string
webHookUrl The webhook URL to send notifications to. string

NotificationChannelTags

Name Description Value
  • Last updated on