Interface NotificationChannel
public interface NotificationChannel
An immutable client-side representation of NotificationChannel.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the NotificationChannel definition.static interface
The NotificationChannel definition stages.static interface
The template for NotificationChannel update.static interface
The NotificationChannel update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the createdDate property: The creation date of the notification channel.Gets the description property: Description of notification.Gets the emailRecipient property: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).events()
Gets the events property: The list of event for which this notification is enabled.id()
Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.NotificationChannelInner object.location()
Gets the location property: The geo-location where the resource lives.name()
Gets the name property: The name of the resource.Gets the notificationLocale property: The locale to use when sending a notification (fallback for unsupported languages is EN).void
notify
(NotifyParameters notifyParameters) Send notification to provided channel.com.azure.core.http.rest.Response<Void>
notifyWithResponse
(NotifyParameters notifyParameters, com.azure.core.util.Context context) Send notification to provided channel.Gets the provisioningState property: The provisioning status of the resource.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).update()
Begins update for the NotificationChannel resource.Gets the webhookUrl property: The webhook URL to send notifications to.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
webhookUrl
String webhookUrl()Gets the webhookUrl property: The webhook URL to send notifications to.- Returns:
- the webhookUrl value.
-
emailRecipient
String emailRecipient()Gets the emailRecipient property: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).- Returns:
- the emailRecipient value.
-
notificationLocale
String notificationLocale()Gets the notificationLocale property: The locale to use when sending a notification (fallback for unsupported languages is EN).- Returns:
- the notificationLocale value.
-
description
String description()Gets the description property: Description of notification.- Returns:
- the description value.
-
events
Gets the events property: The list of event for which this notification is enabled.- Returns:
- the events value.
-
createdDate
OffsetDateTime createdDate()Gets the createdDate property: The creation date of the notification channel.- Returns:
- the createdDate value.
-
provisioningState
String provisioningState()Gets the provisioningState property: The provisioning status of the resource.- Returns:
- the provisioningState value.
-
uniqueIdentifier
String uniqueIdentifier()Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).- Returns:
- the uniqueIdentifier value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
NotificationChannelInner innerModel()Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.NotificationChannelInner object.- Returns:
- the inner object.
-
update
NotificationChannel.Update update()Begins update for the NotificationChannel resource.- Returns:
- the stage of resource update.
-
refresh
NotificationChannel refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
notifyWithResponse
com.azure.core.http.rest.Response<Void> notifyWithResponse(NotifyParameters notifyParameters, com.azure.core.util.Context context) Send notification to provided channel.- Parameters:
notifyParameters
- Properties for generating a Notification.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
notify
Send notification to provided channel.- Parameters:
notifyParameters
- Properties for generating a Notification.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-