Action Groups - Enable Receiver

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.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}/subscribe?api-version=2021-09-01

URI Parameters

Name In Required Type Description
actionGroupName
path True

string

The name of the action group.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
receiverName True

string

The name of the receiver to resubscribe.

Responses

Name Type Description
200 OK

The receiver was successfully enabled.

Other Status Codes

The receiver is already enabled in the action group.

Other Status Codes

ErrorResponse

An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Enable the receiver

Sample request

POST https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/Microsoft.Insights/actionGroups/SampleActionGroup/subscribe?api-version=2021-09-01

{
  "receiverName": "John Doe's mobile"
}

Sample response

Definitions

Name Description
EnableRequest

Describes a receiver that should be resubscribed.

ErrorResponse

Describes the format of Error response.

EnableRequest

Describes a receiver that should be resubscribed.

Name Type Description
receiverName

string

The name of the receiver to resubscribe.

ErrorResponse

Describes the format of Error response.

Name Type Description
code

string

Error code

message

string

Error message indicating why the operation failed.