ActionGroupsOperations interface

Package:

@azure/arm-monitor

Interface representing a ActionGroups operations.

Properties

beginCreateNotificationsAtActionGroupResourceLevel
beginCreateNotificationsAtActionGroupResourceLevelAndWait
beginReconcileNSP
beginReconcileNSPAndWait
createNotificationsAtActionGroupResourceLevel	Send test notifications to a set of provided receivers
createOrUpdate	Create a new action group or update an existing one.
delete	Delete an action group.
enableReceiver	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.
get	Get an action group.
getNSP	Gets a specified NSP configuration for specified action group.
getTestNotificationsAtActionGroupResourceLevel	Get the test notifications by the notification id
listByResourceGroup	Get a list of all action groups in a resource group.
listBySubscriptionId	Get a list of all action groups in a subscription.
listNSP	Gets a list of NSP configurations for specified action group.
reconcileNSP	Reconciles a specified NSP configuration for specified action group.
update	Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.

Property Details

beginCreateNotificationsAtActionGroupResourceLevel

Warning

This API is now deprecated.

use createNotificationsAtActionGroupResourceLevel instead

beginCreateNotificationsAtActionGroupResourceLevel: (resourceGroupName: string, actionGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams) => Promise<SimplePollerLike<OperationState<TestNotificationDetailsResponse>, TestNotificationDetailsResponse>>

Property Value

(resourceGroupName: string, actionGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams) => Promise<SimplePollerLike<OperationState<TestNotificationDetailsResponse>, TestNotificationDetailsResponse>>

beginCreateNotificationsAtActionGroupResourceLevelAndWait

Warning

This API is now deprecated.

use createNotificationsAtActionGroupResourceLevel instead

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

Property Value

(resourceGroupName: string, actionGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams) => Promise<TestNotificationDetailsResponse>

beginReconcileNSP

Warning

This API is now deprecated.

use reconcileNSP instead

beginReconcileNSP: (resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsReconcileNSPOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsReconcileNSPOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginReconcileNSPAndWait

Warning

This API is now deprecated.

use reconcileNSP instead

beginReconcileNSPAndWait: (resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsReconcileNSPOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsReconcileNSPOptionalParams) => Promise<void>

createNotificationsAtActionGroupResourceLevel

Send test notifications to a set of provided receivers

createNotificationsAtActionGroupResourceLevel: (resourceGroupName: string, actionGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams) => PollerLike<OperationState<TestNotificationDetailsResponse>, TestNotificationDetailsResponse>

Property Value

(resourceGroupName: string, actionGroupName: string, notificationRequest: NotificationRequestBody, options?: ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams) => PollerLike<OperationState<TestNotificationDetailsResponse>, TestNotificationDetailsResponse>

createOrUpdate

Create a new action group or update an existing one.

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

Property Value

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

delete

Delete an action group.

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

Property Value

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

enableReceiver

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.

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

Property Value

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

get

Get an action group.

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

Property Value

(resourceGroupName: string, actionGroupName: string, options?: ActionGroupsGetOptionalParams) => Promise<ActionGroupResource>

getNSP

Gets a specified NSP configuration for specified action group.

getNSP: (resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsGetNSPOptionalParams) => Promise<NetworkSecurityPerimeterConfiguration>

Property Value

(resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsGetNSPOptionalParams) => Promise<NetworkSecurityPerimeterConfiguration>

getTestNotificationsAtActionGroupResourceLevel

Get the test notifications by the notification id

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

Property Value

(resourceGroupName: string, actionGroupName: string, notificationId: string, options?: ActionGroupsGetTestNotificationsAtActionGroupResourceLevelOptionalParams) => Promise<TestNotificationDetailsResponse>

listByResourceGroup

Get a list of all action groups in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: ActionGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ActionGroupResource, ActionGroupResource[], PageSettings>

Property Value

(resourceGroupName: string, options?: ActionGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ActionGroupResource, ActionGroupResource[], PageSettings>

listBySubscriptionId

Get a list of all action groups in a subscription.

listBySubscriptionId: (options?: ActionGroupsListBySubscriptionIdOptionalParams) => PagedAsyncIterableIterator<ActionGroupResource, ActionGroupResource[], PageSettings>

Property Value

(options?: ActionGroupsListBySubscriptionIdOptionalParams) => PagedAsyncIterableIterator<ActionGroupResource, ActionGroupResource[], PageSettings>

listNSP

Gets a list of NSP configurations for specified action group.

listNSP: (resourceGroupName: string, actionGroupName: string, options?: ActionGroupsListNSPOptionalParams) => PagedAsyncIterableIterator<NetworkSecurityPerimeterConfiguration, NetworkSecurityPerimeterConfiguration[], PageSettings>

Property Value

(resourceGroupName: string, actionGroupName: string, options?: ActionGroupsListNSPOptionalParams) => PagedAsyncIterableIterator<NetworkSecurityPerimeterConfiguration, NetworkSecurityPerimeterConfiguration[], PageSettings>

reconcileNSP

Reconciles a specified NSP configuration for specified action group.

reconcileNSP: (resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsReconcileNSPOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, actionGroupName: string, networkSecurityPerimeterConfigurationName: string, options?: ActionGroupsReconcileNSPOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.

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

Property Value

(resourceGroupName: string, actionGroupName: string, actionGroupPatch: ActionGroupPatchBody, options?: ActionGroupsUpdateOptionalParams) => Promise<ActionGroupResource>