Microsoft.DevTestLab labs/notificationchannels 2016-05-15

  • Article

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@2016-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    events: [
      {
        eventName: 'string'
      }
    ]
    provisioningState: 'string'
    uniqueIdentifier: 'string'
    webHookUrl: 'string'
  }
}

Property values

labs/notificationchannels

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The location of the resource. string
tags The tags of the resource. Dictionary of tag names and values. See Tags in templates
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)

NotificationChannelProperties

Name Description Value
description Description of notification. string
events The list of event for which this notification is enabled. Event[]
provisioningState The provisioning status of the resource. string
uniqueIdentifier The unique immutable identifier of a resource (Guid). string
webHookUrl The webhook URL to send notifications to. string

Event

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

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": "2016-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "description": "string",
    "events": [
      {
        "eventName": "string"
      }
    ],
    "provisioningState": "string",
    "uniqueIdentifier": "string",
    "webHookUrl": "string"
  }
}

Property values

labs/notificationchannels

Name Description Value
type The resource type 'Microsoft.DevTestLab/labs/notificationchannels'
apiVersion The resource api version '2016-05-15'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The location of the resource. string
tags The tags of the resource. Dictionary of tag names and values. See Tags in templates
properties The properties of the resource. NotificationChannelProperties (required)

NotificationChannelProperties

Name Description Value
description Description of notification. string
events The list of event for which this notification is enabled. Event[]
provisioningState The provisioning status of the resource. string
uniqueIdentifier The unique immutable identifier of a resource (Guid). string
webHookUrl The webhook URL to send notifications to. string

Event

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

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@2016-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      description = "string"
      events = [
        {
          eventName = "string"
        }
      ]
      provisioningState = "string"
      uniqueIdentifier = "string"
      webHookUrl = "string"
    }
  })
}

Property values

labs/notificationchannels

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

NotificationChannelProperties

Name Description Value
description Description of notification. string
events The list of event for which this notification is enabled. Event[]
provisioningState The provisioning status of the resource. string
uniqueIdentifier The unique immutable identifier of a resource (Guid). string
webHookUrl The webhook URL to send notifications to. string

Event

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