Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. devtestlab
  5. getNotificationChannel
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.devtestlab.getNotificationChannel

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get notification channel. Azure REST API version: 2018-09-15.

Using getNotificationChannel

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNotificationChannel(args: GetNotificationChannelArgs, opts?: InvokeOptions): Promise<GetNotificationChannelResult>
function getNotificationChannelOutput(args: GetNotificationChannelOutputArgs, opts?: InvokeOptions): Output<GetNotificationChannelResult>
Copy
def get_notification_channel(expand: Optional[str] = None,
                             lab_name: Optional[str] = None,
                             name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetNotificationChannelResult
def get_notification_channel_output(expand: Optional[pulumi.Input[str]] = None,
                             lab_name: Optional[pulumi.Input[str]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetNotificationChannelResult]
Copy
func LookupNotificationChannel(ctx *Context, args *LookupNotificationChannelArgs, opts ...InvokeOption) (*LookupNotificationChannelResult, error)
func LookupNotificationChannelOutput(ctx *Context, args *LookupNotificationChannelOutputArgs, opts ...InvokeOption) LookupNotificationChannelResultOutput
Copy

> Note: This function is named LookupNotificationChannel in the Go SDK.

public static class GetNotificationChannel 
{
    public static Task<GetNotificationChannelResult> InvokeAsync(GetNotificationChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetNotificationChannelResult> Invoke(GetNotificationChannelInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNotificationChannelResult> getNotificationChannel(GetNotificationChannelArgs args, InvokeOptions options)
public static Output<GetNotificationChannelResult> getNotificationChannel(GetNotificationChannelArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devtestlab:getNotificationChannel
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the notification channel.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($select=webHookUrl)'
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the notification channel.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($select=webHookUrl)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the notification channel.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Specify the $expand query. Example: 'properties($select=webHookUrl)'
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the notification channel.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
Specify the $expand query. Example: 'properties($select=webHookUrl)'
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the notification channel.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
Specify the $expand query. Example: 'properties($select=webHookUrl)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the notification channel.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Specify the $expand query. Example: 'properties($select=webHookUrl)'

getNotificationChannel Result

The following output properties are available:

CreatedDate string
The creation date of the notification channel.
Id string
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
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 List<Pulumi.AzureNative.DevTestLab.Outputs.EventResponse>
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).
Tags Dictionary<string, string>
The tags of the resource.
WebHookUrl string
The webhook URL to send notifications to.
CreatedDate string
The creation date of the notification channel.
Id string
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
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 []EventResponse
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).
Tags map[string]string
The tags of the resource.
WebHookUrl string
The webhook URL to send notifications to.
createdDate String
The creation date of the notification channel.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
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 List<EventResponse>
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).
tags Map<String,String>
The tags of the resource.
webHookUrl String
The webhook URL to send notifications to.
createdDate string
The creation date of the notification channel.
id string
The identifier of the resource.
name string
The name of the resource.
provisioningState string
The provisioning status of the resource.
type string
The type of the resource.
uniqueIdentifier string
The unique immutable identifier of a resource (Guid).
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 EventResponse[]
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).
tags {[key: string]: string}
The tags of the resource.
webHookUrl string
The webhook URL to send notifications to.
created_date str
The creation date of the notification channel.
id str
The identifier of the resource.
name str
The name of the resource.
provisioning_state str
The provisioning status of the resource.
type str
The type of the resource.
unique_identifier str
The unique immutable identifier of a resource (Guid).
description str
Description of notification.
email_recipient str
The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
events Sequence[EventResponse]
The list of event for which this notification is enabled.
location str
The location of the resource.
notification_locale str
The locale to use when sending a notification (fallback for unsupported languages is EN).
tags Mapping[str, str]
The tags of the resource.
web_hook_url str
The webhook URL to send notifications to.
createdDate String
The creation date of the notification channel.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
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 List<Property Map>
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).
tags Map<String>
The tags of the resource.
webHookUrl String
The webhook URL to send notifications to.

Supporting Types

EventResponse

EventName string
The event type for which this notification is enabled (i.e. AutoShutdown, Cost)
EventName string
The event type for which this notification is enabled (i.e. AutoShutdown, Cost)
eventName String
The event type for which this notification is enabled (i.e. AutoShutdown, Cost)
eventName string
The event type for which this notification is enabled (i.e. AutoShutdown, Cost)
event_name str
The event type for which this notification is enabled (i.e. AutoShutdown, Cost)
eventName String
The event type for which this notification is enabled (i.e. AutoShutdown, Cost)

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native