Notification Channels - Notify

Send notification to provided channel.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify?api-version=2018-09-15

URI Parameters

Name In Required Type Description
labName
path True

string

The name of the lab.

name
path True

string

The name of the notification channel.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription ID.

api-version
query True

string

Client API version.

Request Body

Name Type Description
eventName

NotificationChannelEventType

The type of event (i.e. AutoShutdown, Cost)

jsonPayload

string

Properties for the notification in json format.

Responses

Name Type Description
200 OK

OK

Other Status Codes

CloudError

BadRequest

Security

azure_auth

OAuth2 Implicit Grant

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Access Microsoft Azure

Examples

NotificationChannels_Notify

Sample Request

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{notificationChannelName}/notify?api-version=2018-09-15

{
  "eventName": "AutoShutdown",
  "jsonPayload": "{\"eventType\":\"AutoShutdown\",\"subscriptionId\":\"{subscriptionId}\",\"resourceGroupName\":\"resourceGroupName\",\"labName\":\"{labName}\"}"
}

Sample Response

Definitions

Name Description
CloudError

Error from a REST request.

CloudErrorBody

Body of an error from a REST request.

NotificationChannelEventType

The event type for which this notification is enabled (i.e. AutoShutdown, Cost)

NotifyParameters

Properties for generating a Notification.

CloudError

Error from a REST request.

Name Type Description
error

CloudErrorBody

The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name Type Description
code

string

The error code.

details

CloudErrorBody[]

Inner errors.

message

string

The error message.

target

string

The error target.

NotificationChannelEventType

The event type for which this notification is enabled (i.e. AutoShutdown, Cost)

Name Type Description
AutoShutdown

string

Cost

string

NotifyParameters

Properties for generating a Notification.

Name Type Description
eventName

NotificationChannelEventType

The type of event (i.e. AutoShutdown, Cost)

jsonPayload

string

Properties for the notification in json format.