Replication Alert Settings - Create

Service:

Recovery Services - Site Recovery

API Version:

2024-10-01

Configures email notifications for this vault.
Create or update an email notification(alert) configuration.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
alertSettingName	path	True	string	The name of the email notification(alert) configuration.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
resourceName	path	True	string	The name of the recovery services vault.
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
properties	ConfigureAlertRequestProperties	The properties of a configure alert request.

Responses

Name	Type	Description
200 OK	Alert	OK

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

Configures email notifications for this vault.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting?api-version=2024-10-01

{
  "properties": {
    "sendToOwners": "false",
    "customEmailAddresses": [
      "ronehr@microsoft.com"
    ],
    "locale": ""
  }
}

Sample response

Status code:

200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-10-01

{
  "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings",
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting",
  "name": "defaultAlertSetting",
  "properties": {
    "sendToOwners": "false",
    "customEmailAddresses": [
      "ronehr@microsoft.com"
    ],
    "locale": "en-US"
  }
}

Definitions

Name	Description
Alert	Implements the Alert class.
AlertProperties	The properties of an alert.
ConfigureAlertRequest	Request to configure alerts for the system.
ConfigureAlertRequestProperties	Properties of a configure alert request.

Alert

Object

Implements the Alert class.

Name	Type	Description
id	string	Resource Id
location	string	Resource Location
name	string	Resource Name
properties	AlertProperties	Alert related data.
type	string	Resource Type

AlertProperties

Object

The properties of an alert.

Name	Type	Description
customEmailAddresses	string[]	The custom email address for sending emails.
locale	string	The locale for the email notification.
sendToOwners	string	A value indicating whether to send email to subscription administrator.

ConfigureAlertRequest

Object

Request to configure alerts for the system.

Name	Type	Description
properties	ConfigureAlertRequestProperties	The properties of a configure alert request.

ConfigureAlertRequestProperties

Object

Properties of a configure alert request.

Name	Type	Description
customEmailAddresses	string[]	The custom email address for sending emails.
locale	string	The locale for the email notification.
sendToOwners	string	A value indicating whether to send email to subscription administrator.