GetNotificationChannel
A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.
To get more information about NotificationChannel, see:
Using GetNotificationChannel
function getNotificationChannel(args: GetNotificationChannelArgs, opts?: InvokeOptions): Promise<GetNotificationChannelResult>function get_notification_channel(display_name=None, labels=None, project=None, type=None, user_labels=None, opts=None)func LookupNotificationChannel(ctx *Context, args *LookupNotificationChannelArgs, opts ...InvokeOption) (*LookupNotificationChannelResult, error)Note: This function is named
LookupNotificationChannelin the Go SDK.
public static class GetNotificationChannel {
public static Task<GetNotificationChannelResult> InvokeAsync(GetNotificationChannelArgs args, InvokeOptions? opts = null)
}The following arguments are supported:
- Display
Name string The display name for this notification channel.
- Labels Dictionary<string, string>
Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Type string
The type of the notification channel.
- User
Labels Dictionary<string, string> User-provided key-value labels to filter by.
- Display
Name string The display name for this notification channel.
- Labels map[string]string
Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Type string
The type of the notification channel.
- User
Labels map[string]string User-provided key-value labels to filter by.
- display
Name string The display name for this notification channel.
- labels {[key: string]: string}
Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- type string
The type of the notification channel.
- user
Labels {[key: string]: string} User-provided key-value labels to filter by.
- display_
name str The display name for this notification channel.
- labels Dict[str, str]
Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- type str
The type of the notification channel.
- user_
labels Dict[str, str] User-provided key-value labels to filter by.
GetNotificationChannel Result
The following output properties are available:
- Description string
- Enabled bool
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
- Sensitive
Labels List<GetNotification Channel Sensitive Label> - Verification
Status string - Display
Name string - Labels Dictionary<string, string>
- Project string
- Type string
- User
Labels Dictionary<string, string>
- Description string
- Enabled bool
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
- Sensitive
Labels []GetNotification Channel Sensitive Label - Verification
Status string - Display
Name string - Labels map[string]string
- Project string
- Type string
- User
Labels map[string]string
- description string
- enabled boolean
- id string
The provider-assigned unique ID for this managed resource.
- name string
- sensitive
Labels GetNotification Channel Sensitive Label[] - verification
Status string - display
Name string - labels {[key: string]: string}
- project string
- type string
- user
Labels {[key: string]: string}
- description str
- enabled bool
- id str
The provider-assigned unique ID for this managed resource.
- name str
- sensitive_
labels List[GetNotification Channel Sensitive Label] - verification_
status str - display_
name str - labels Dict[str, str]
- project str
- type str
- user_
labels Dict[str, str]
Supporting Types
GetNotificationChannelSensitiveLabel
See the output API doc for this type.
See the output API doc for this type.
See the output API doc for this type.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.