ActionGroupsImpl | @azure/arm-monitor

Class containing ActionGroups operations.

Hierarchy

ActionGroupsImpl

Implements

ActionGroups

Index

Constructors

constructor

Methods

Constructors

constructor

new ActionGroupsImpl(client: MonitorClient): ActionGroupsImpl

- Defined in operations/actionGroups.ts:51
Initialize a new instance of the class ActionGroups class.

Parameters
- client: MonitorClient
  
  Reference to the service client
Returns ActionGroupsImpl

Methods

beginCreateNotificationsAtActionGroupResourceLevel

beginCreateNotificationsAtActionGroupResourceLevel(resourceGroupName: string, actionGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams): Promise<PollerLike<PollOperationState<ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>, ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>>

Implementation of ActionGroups.beginCreateNotificationsAtActionGroupResourceLevel
- Defined in operations/actionGroups.ts:392
Send test notifications to a set of provided receivers

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- actionGroupName: string
  
  The name of the action group.
- notificationRequest: NotificationRequestBody
  
  The notification request body which includes the contact details
- Optional options: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>, ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>>

beginCreateNotificationsAtActionGroupResourceLevelAndWait

beginCreateNotificationsAtActionGroupResourceLevelAndWait(resourceGroupName: string, actionGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams): Promise<ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>

Implementation of ActionGroups.beginCreateNotificationsAtActionGroupResourceLevelAndWait
- Defined in operations/actionGroups.ts:465
Send test notifications to a set of provided receivers

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- actionGroupName: string
  
  The name of the action group.
- notificationRequest: NotificationRequestBody
  
  The notification request body which includes the contact details
- Optional options: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>

beginCreateNotificationsAtResourceGroupLevel

beginCreateNotificationsAtResourceGroupLevel(resourceGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtResourceGroupLevelOptionalParams): Promise<PollerLike<PollOperationState<ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>, ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>>

Implementation of ActionGroups.beginCreateNotificationsAtResourceGroupLevel
- Defined in operations/actionGroups.ts:301
Send test notifications to a set of provided receivers

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- notificationRequest: NotificationRequestBody
  
  The notification request body which includes the contact details
- Optional options: ActionGroupsCreateNotificationsAtResourceGroupLevelOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>, ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>>

beginCreateNotificationsAtResourceGroupLevelAndWait

beginCreateNotificationsAtResourceGroupLevelAndWait(resourceGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtResourceGroupLevelOptionalParams): Promise<ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>

Implementation of ActionGroups.beginCreateNotificationsAtResourceGroupLevelAndWait
- Defined in operations/actionGroups.ts:372
Send test notifications to a set of provided receivers

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- notificationRequest: NotificationRequestBody
  
  The notification request body which includes the contact details
- Optional options: ActionGroupsCreateNotificationsAtResourceGroupLevelOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>

beginPostTestNotifications

beginPostTestNotifications(notificationRequest: NotificationRequestBody, options?: ActionGroupsPostTestNotificationsOptionalParams): Promise<PollerLike<PollOperationState<ActionGroupsPostTestNotificationsResponse>, ActionGroupsPostTestNotificationsResponse>>

Implementation of ActionGroups.beginPostTestNotifications
- Defined in operations/actionGroups.ts:217
Send test notifications to a set of provided receivers

Parameters
- notificationRequest: NotificationRequestBody
  
  The notification request body which includes the contact details
- Optional options: ActionGroupsPostTestNotificationsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ActionGroupsPostTestNotificationsResponse>, ActionGroupsPostTestNotificationsResponse>>

beginPostTestNotificationsAndWait

beginPostTestNotificationsAndWait(notificationRequest: NotificationRequestBody, options?: ActionGroupsPostTestNotificationsOptionalParams): Promise<ActionGroupsPostTestNotificationsResponse>

Implementation of ActionGroups.beginPostTestNotificationsAndWait
- Defined in operations/actionGroups.ts:284
Send test notifications to a set of provided receivers

Parameters
- notificationRequest: NotificationRequestBody
  
  The notification request body which includes the contact details
- Optional options: ActionGroupsPostTestNotificationsOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsPostTestNotificationsResponse>

createOrUpdate

createOrUpdate(resourceGroupName: string, actionGroupName: string, actionGroup: ActionGroupResource, options?: ActionGroupsCreateOrUpdateOptionalParams): Promise<ActionGroupsCreateOrUpdateResponse>

Implementation of ActionGroups.createOrUpdate
- Defined in operations/actionGroups.ts:147
Create a new action group or update an existing one.

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.
- Optional options: ActionGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, actionGroupName: string, options?: ActionGroupsDeleteOptionalParams): Promise<void>

Implementation of ActionGroups.delete
- Defined in operations/actionGroups.ts:182
Delete an action group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- actionGroupName: string
  
  The name of the action group.
- Optional options: ActionGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

enableReceiver

enableReceiver(resourceGroupName: string, actionGroupName: string, enableRequest: EnableRequest, options?: ActionGroupsEnableReceiverOptionalParams): Promise<void>

Implementation of ActionGroups.enableReceiver
- Defined in operations/actionGroups.ts:571
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.

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.
- Optional options: ActionGroupsEnableReceiverOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, actionGroupName: string, options?: ActionGroupsGetOptionalParams): Promise<ActionGroupsGetResponse>

Implementation of ActionGroups.get
- Defined in operations/actionGroups.ts:165
Get an action group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- actionGroupName: string
  
  The name of the action group.
- Optional options: ActionGroupsGetOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsGetResponse>

getTestNotifications

getTestNotifications(notificationId: string, options?: ActionGroupsGetTestNotificationsOptionalParams): Promise<ActionGroupsGetTestNotificationsResponse>

Implementation of ActionGroups.getTestNotifications
- Defined in operations/actionGroups.ts:487
Get the test notifications by the notification id

Parameters
- notificationId: string
  
  The notification id
- Optional options: ActionGroupsGetTestNotificationsOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsGetTestNotificationsResponse>

getTestNotificationsAtActionGroupResourceLevel

getTestNotificationsAtActionGroupResourceLevel(resourceGroupName: string, actionGroupName: string, notificationId: string, options?: ActionGroupsGetTestNotificationsAtActionGroupResourceLevelOptionalParams): Promise<ActionGroupsGetTestNotificationsAtActionGroupResourceLevelResponse>

Implementation of ActionGroups.getTestNotificationsAtActionGroupResourceLevel
- Defined in operations/actionGroups.ts:521
Get the test notifications by the notification id

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- actionGroupName: string
  
  The name of the action group.
- notificationId: string
  
  The notification id
- Optional options: ActionGroupsGetTestNotificationsAtActionGroupResourceLevelOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsGetTestNotificationsAtActionGroupResourceLevelResponse>

getTestNotificationsAtResourceGroupLevel

getTestNotificationsAtResourceGroupLevel(resourceGroupName: string, notificationId: string, options?: ActionGroupsGetTestNotificationsAtResourceGroupLevelOptionalParams): Promise<ActionGroupsGetTestNotificationsAtResourceGroupLevelResponse>

Implementation of ActionGroups.getTestNotificationsAtResourceGroupLevel
- Defined in operations/actionGroups.ts:503
Get the test notifications by the notification id

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- notificationId: string
  
  The notification id
- Optional options: ActionGroupsGetTestNotificationsAtResourceGroupLevelOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsGetTestNotificationsAtResourceGroupLevelResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ActionGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ActionGroupResource>

Implementation of ActionGroups.listByResourceGroup
- Defined in operations/actionGroups.ts:102
Get a list of all action groups in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: ActionGroupsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ActionGroupResource>

listBySubscriptionId

listBySubscriptionId(options?: ActionGroupsListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<ActionGroupResource>

Implementation of ActionGroups.listBySubscriptionId
- Defined in operations/actionGroups.ts:65
Get a list of all action groups in a subscription.

Parameters
- Optional options: ActionGroupsListBySubscriptionIdOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ActionGroupResource>

update

update(resourceGroupName: string, actionGroupName: string, actionGroupPatch: ActionGroupPatchBody, options?: ActionGroupsUpdateOptionalParams): Promise<ActionGroupsUpdateResponse>

Implementation of ActionGroups.update
- Defined in operations/actionGroups.ts:200
Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.

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.
- Optional options: ActionGroupsUpdateOptionalParams
  
  The options parameters.
Returns Promise<ActionGroupsUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: MonitorClient

Returns ActionGroupsImpl

Methods

beginCreateNotificationsAtActionGroupResourceLevel

Parameters

resourceGroupName: string

actionGroupName: string

notificationRequest: NotificationRequestBody

Optional options: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams

Returns Promise<PollerLike<PollOperationState<ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>, ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>>

beginCreateNotificationsAtActionGroupResourceLevelAndWait

Parameters

resourceGroupName: string

actionGroupName: string

notificationRequest: NotificationRequestBody

Optional options: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams

Returns Promise<ActionGroupsCreateNotificationsAtActionGroupResourceLevelResponse>

beginCreateNotificationsAtResourceGroupLevel

Parameters

resourceGroupName: string

notificationRequest: NotificationRequestBody

Optional options: ActionGroupsCreateNotificationsAtResourceGroupLevelOptionalParams

Returns Promise<PollerLike<PollOperationState<ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>, ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>>

beginCreateNotificationsAtResourceGroupLevelAndWait

Parameters

resourceGroupName: string

notificationRequest: NotificationRequestBody

Optional options: ActionGroupsCreateNotificationsAtResourceGroupLevelOptionalParams

Returns Promise<ActionGroupsCreateNotificationsAtResourceGroupLevelResponse>

beginPostTestNotifications

Parameters

notificationRequest: NotificationRequestBody

Optional options: ActionGroupsPostTestNotificationsOptionalParams

Returns Promise<PollerLike<PollOperationState<ActionGroupsPostTestNotificationsResponse>, ActionGroupsPostTestNotificationsResponse>>

beginPostTestNotificationsAndWait

Parameters

notificationRequest: NotificationRequestBody

Optional options: ActionGroupsPostTestNotificationsOptionalParams

Returns Promise<ActionGroupsPostTestNotificationsResponse>

createOrUpdate

Parameters

resourceGroupName: string

actionGroupName: string

actionGroup: ActionGroupResource

Optional options: ActionGroupsCreateOrUpdateOptionalParams

Returns Promise<ActionGroupsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

actionGroupName: string

Optional options: ActionGroupsDeleteOptionalParams

Returns Promise<void>

enableReceiver

Parameters

resourceGroupName: string

actionGroupName: string

enableRequest: EnableRequest

Optional options: ActionGroupsEnableReceiverOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

actionGroupName: string

Optional options: ActionGroupsGetOptionalParams

Returns Promise<ActionGroupsGetResponse>

getTestNotifications

Parameters

notificationId: string

Optional options: ActionGroupsGetTestNotificationsOptionalParams

Returns Promise<ActionGroupsGetTestNotificationsResponse>

getTestNotificationsAtActionGroupResourceLevel

Parameters