ActionGroups interface
Interface representing a ActionGroups.
Methods
Method Details
beginPostTestNotifications(NotificationRequestBody, ActionGroupsPostTestNotificationsOptionalParams)
Send test notifications to a set of provided receivers
function beginPostTestNotifications(notificationRequest: NotificationRequestBody, options?: ActionGroupsPostTestNotificationsOptionalParams): Promise<PollerLike<PollOperationState<TestNotificationResponse>, TestNotificationResponse>>Parameters
- notificationRequest
- NotificationRequestBody
The notification request body which includes the contact details
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<TestNotificationResponse>, TestNotificationResponse>>
beginPostTestNotificationsAndWait(NotificationRequestBody, ActionGroupsPostTestNotificationsOptionalParams)
Send test notifications to a set of provided receivers
function beginPostTestNotificationsAndWait(notificationRequest: NotificationRequestBody, options?: ActionGroupsPostTestNotificationsOptionalParams): Promise<TestNotificationResponse>Parameters
- notificationRequest
- NotificationRequestBody
The notification request body which includes the contact details
The options parameters.
Returns
Promise<TestNotificationResponse>
createOrUpdate(string, string, ActionGroupResource, ActionGroupsCreateOrUpdateOptionalParams)
Create a new action group or update an existing one.
function createOrUpdate(resourceGroupName: string, actionGroupName: string, actionGroup: ActionGroupResource, options?: ActionGroupsCreateOrUpdateOptionalParams): Promise<ActionGroupResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- actionGroupName
-
string
The name of the action group.
- actionGroup
- ActionGroupResource
The action group to create or use for the update.
The options parameters.
Returns
Promise<ActionGroupResource>
delete(string, string, ActionGroupsDeleteOptionalParams)
Delete an action group.
function delete(resourceGroupName: string, actionGroupName: string, options?: ActionGroupsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- actionGroupName
-
string
The name of the action group.
- options
- ActionGroupsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
enableReceiver(string, string, EnableRequest, ActionGroupsEnableReceiverOptionalParams)
Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.
function enableReceiver(resourceGroupName: string, actionGroupName: string, enableRequest: EnableRequest, options?: ActionGroupsEnableReceiverOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- actionGroupName
-
string
The name of the action group.
- enableRequest
- EnableRequest
The receiver to re-enable.
The options parameters.
Returns
Promise<void>
get(string, string, ActionGroupsGetOptionalParams)
Get an action group.
function get(resourceGroupName: string, actionGroupName: string, options?: ActionGroupsGetOptionalParams): Promise<ActionGroupResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- actionGroupName
-
string
The name of the action group.
- options
- ActionGroupsGetOptionalParams
The options parameters.
Returns
Promise<ActionGroupResource>
getTestNotifications(string, ActionGroupsGetTestNotificationsOptionalParams)
Get the test notifications by the notification id
function getTestNotifications(notificationId: string, options?: ActionGroupsGetTestNotificationsOptionalParams): Promise<TestNotificationDetailsResponse>Parameters
- notificationId
-
string
The notification id
The options parameters.
Returns
Promise<TestNotificationDetailsResponse>
listByResourceGroup(string, ActionGroupsListByResourceGroupOptionalParams)
Get a list of all action groups in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: ActionGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ActionGroupResource, ActionGroupResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscriptionId(ActionGroupsListBySubscriptionIdOptionalParams)
Get a list of all action groups in a subscription.
function listBySubscriptionId(options?: ActionGroupsListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<ActionGroupResource, ActionGroupResource[], PageSettings>Parameters
The options parameters.
Returns
update(string, string, ActionGroupPatchBody, ActionGroupsUpdateOptionalParams)
Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.
function update(resourceGroupName: string, actionGroupName: string, actionGroupPatch: ActionGroupPatchBody, options?: ActionGroupsUpdateOptionalParams): Promise<ActionGroupResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- actionGroupName
-
string
The name of the action group.
- actionGroupPatch
- ActionGroupPatchBody
Parameters supplied to the operation.
- options
- ActionGroupsUpdateOptionalParams
The options parameters.
Returns
Promise<ActionGroupResource>