Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ActionGroups

Package version

Class representing a ActionGroups.

Hierarchy

  • ActionGroups

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, actionGroupName: string, actionGroup: ActionGroupResource, options?: msRest.RequestOptionsBase): Promise<Models.ActionGroupsCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, actionGroupName: string, actionGroup: ActionGroupResource, callback: msRest.ServiceCallback<ActionGroupResource>): void
  • createOrUpdate(resourceGroupName: string, actionGroupName: string, actionGroup: ActionGroupResource, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ActionGroupResource>): void

  • Create a new action group or update an existing one.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • actionGroup: ActionGroupResource

      The action group to create or use for the update.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ActionGroupsCreateOrUpdateResponse>

    Promise<Models.ActionGroupsCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • actionGroup: ActionGroupResource

      The action group to create or use for the update.

    • callback: msRest.ServiceCallback<ActionGroupResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • actionGroup: ActionGroupResource

      The action group to create or use for the update.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ActionGroupResource>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, actionGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, actionGroupName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, actionGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Delete an action group.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

enableReceiver

  • enableReceiver(resourceGroupName: string, actionGroupName: string, receiverName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • enableReceiver(resourceGroupName: string, actionGroupName: string, receiverName: string, callback: msRest.ServiceCallback<void>): void
  • enableReceiver(resourceGroupName: string, actionGroupName: string, receiverName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • 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.

    • actionGroupName: string

      The name of the action group.

    • receiverName: string

      The name of the receiver to resubscribe.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • receiverName: string

      The name of the receiver to resubscribe.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • receiverName: string

      The name of the receiver to resubscribe.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, actionGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ActionGroupsGetResponse>
  • get(resourceGroupName: string, actionGroupName: string, callback: msRest.ServiceCallback<ActionGroupResource>): void
  • get(resourceGroupName: string, actionGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ActionGroupResource>): void

  • Get an action group.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ActionGroupsGetResponse>

    Promise<Models.ActionGroupsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • callback: msRest.ServiceCallback<ActionGroupResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ActionGroupResource>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ActionGroupsListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ActionGroupList>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ActionGroupList>): void

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ActionGroupsListByResourceGroupResponse>

    Promise<Models.ActionGroupsListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • callback: msRest.ServiceCallback<ActionGroupList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ActionGroupList>

      The callback

    Returns void

listBySubscriptionId

  • listBySubscriptionId(options?: msRest.RequestOptionsBase): Promise<Models.ActionGroupsListBySubscriptionIdResponse>
  • listBySubscriptionId(callback: msRest.ServiceCallback<ActionGroupList>): void
  • listBySubscriptionId(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ActionGroupList>): void

update

  • update(resourceGroupName: string, actionGroupName: string, actionGroupPatch: ActionGroupPatchBody, options?: msRest.RequestOptionsBase): Promise<Models.ActionGroupsUpdateResponse>
  • update(resourceGroupName: string, actionGroupName: string, actionGroupPatch: ActionGroupPatchBody, callback: msRest.ServiceCallback<ActionGroupResource>): void
  • update(resourceGroupName: string, actionGroupName: string, actionGroupPatch: ActionGroupPatchBody, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ActionGroupResource>): void

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • actionGroupPatch: ActionGroupPatchBody

      Parameters supplied to the operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ActionGroupsUpdateResponse>

    Promise<Models.ActionGroupsUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • actionGroupPatch: ActionGroupPatchBody

      Parameters supplied to the operation.

    • callback: msRest.ServiceCallback<ActionGroupResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • actionGroupName: string

      The name of the action group.

    • actionGroupPatch: ActionGroupPatchBody

      Parameters supplied to the operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ActionGroupResource>

      The callback

    Returns void

Generated using TypeDoc