Interface NotificationChannelsClient
public interface NotificationChannelsClient
An instance of this class provides access to all the operations defined in NotificationChannelsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdate
(String resourceGroupName, String labName, String name, NotificationChannelInner notificationChannel) Create or replace an existing notification channel.com.azure.core.http.rest.Response<NotificationChannelInner>
createOrUpdateWithResponse
(String resourceGroupName, String labName, String name, NotificationChannelInner notificationChannel, com.azure.core.util.Context context) Create or replace an existing notification channel.void
Delete notification channel.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String labName, String name, com.azure.core.util.Context context) Delete notification channel.Get notification channel.com.azure.core.http.rest.Response<NotificationChannelInner>
getWithResponse
(String resourceGroupName, String labName, String name, String expand, com.azure.core.util.Context context) Get notification channel.com.azure.core.http.rest.PagedIterable<NotificationChannelInner>
List notification channels in a given lab.com.azure.core.http.rest.PagedIterable<NotificationChannelInner>
list
(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List notification channels in a given lab.void
notify
(String resourceGroupName, String labName, String name, NotifyParameters notifyParameters) Send notification to provided channel.com.azure.core.http.rest.Response<Void>
notifyWithResponse
(String resourceGroupName, String labName, String name, NotifyParameters notifyParameters, com.azure.core.util.Context context) Send notification to provided channel.update
(String resourceGroupName, String labName, String name, NotificationChannelFragment notificationChannel) Allows modifying tags of notification channels.com.azure.core.http.rest.Response<NotificationChannelInner>
updateWithResponse
(String resourceGroupName, String labName, String name, NotificationChannelFragment notificationChannel, com.azure.core.util.Context context) Allows modifying tags of notification channels.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<NotificationChannelInner> list(String resourceGroupName, String labName) List notification channels in a given lab.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.- Returns:
- the response of a list operation as paginated response with
PagedIterable
. - 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.
-
list
com.azure.core.http.rest.PagedIterable<NotificationChannelInner> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List notification channels in a given lab.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.expand
- Specify the $expand query. Example: 'properties($select=webHookUrl)'.filter
- The filter to apply to the operation. Example: '$filter=contains(name,'myName').top
- The maximum number of resources to return from the operation. Example: '$top=10'.orderby
- The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.context
- The context to associate with this operation.- Returns:
- the response of a list operation as paginated response with
PagedIterable
. - 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.
-
getWithResponse
com.azure.core.http.rest.Response<NotificationChannelInner> getWithResponse(String resourceGroupName, String labName, String name, String expand, com.azure.core.util.Context context) Get notification channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.expand
- Specify the $expand query. Example: 'properties($select=webHookUrl)'.context
- The context to associate with this operation.- Returns:
- notification channel along with
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.
-
get
Get notification channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.- Returns:
- notification channel.
- 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.
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<NotificationChannelInner> createOrUpdateWithResponse(String resourceGroupName, String labName, String name, NotificationChannelInner notificationChannel, com.azure.core.util.Context context) Create or replace an existing notification channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.notificationChannel
- A notification.context
- The context to associate with this operation.- Returns:
- a notification along with
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.
-
createOrUpdate
NotificationChannelInner createOrUpdate(String resourceGroupName, String labName, String name, NotificationChannelInner notificationChannel) Create or replace an existing notification channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.notificationChannel
- A notification.- Returns:
- 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.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String labName, String name, com.azure.core.util.Context context) Delete notification channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.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.
-
delete
Delete notification channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.- 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.
-
updateWithResponse
com.azure.core.http.rest.Response<NotificationChannelInner> updateWithResponse(String resourceGroupName, String labName, String name, NotificationChannelFragment notificationChannel, com.azure.core.util.Context context) Allows modifying tags of notification channels. All other properties will be ignored.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.notificationChannel
- A notification.context
- The context to associate with this operation.- Returns:
- a notification along with
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.
-
update
NotificationChannelInner update(String resourceGroupName, String labName, String name, NotificationChannelFragment notificationChannel) Allows modifying tags of notification channels. All other properties will be ignored.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.notificationChannel
- A notification.- Returns:
- 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.
-
notifyWithResponse
com.azure.core.http.rest.Response<Void> notifyWithResponse(String resourceGroupName, String labName, String name, NotifyParameters notifyParameters, com.azure.core.util.Context context) Send notification to provided channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.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
void notify(String resourceGroupName, String labName, String name, NotifyParameters notifyParameters) Send notification to provided channel.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the notification channel.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.
-