replication_alert_settings

Creates, updates, deletes, gets or lists a replication_alert_settings resource.

Overview

Name	replication_alert_settings
Type	Resource
Id	azure.recovery_services_site_recovery.replication_alert_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customEmailAddresses	array	The custom email address for sending emails.
locale	string	The locale for the email notification.
location	string	Resource Location.
sendToOwners	string	A value indicating whether to send email to subscription administrator.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customEmailAddresses	array	The custom email address for sending emails.
locale	string	The locale for the email notification.
location	string	Resource Location.
sendToOwners	string	A value indicating whether to send email to subscription administrator.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, alert_setting_name, subscription_id		Gets an email notification(alert) configuration. Gets the details of the specified email notification(alert) configuration.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of configured email notification(alert) configurations. Gets the list of email notification(alert) configurations for the vault.
create	insert	resource_group_name, resource_name, alert_setting_name, subscription_id		Configures email notifications for this vault. Create or update an email notification(alert) configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alert_setting_name	string	The name of the email notification configuration. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string

SELECT examples

get

Gets an email notification(alert) configuration. Gets the details of the specified email notification(alert) configuration.

SELECT
id,
name,
customEmailAddresses,
locale,
location,
sendToOwners,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_alert_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND alert_setting_name = '{{ alert_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of configured email notification(alert) configurations. Gets the list of email notification(alert) configurations for the vault.

SELECT
id,
name,
customEmailAddresses,
locale,
location,
sendToOwners,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_alert_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.recovery_services_site_recovery.replication_alert_settings (
properties,
resource_group_name,
resource_name,
alert_setting_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ alert_setting_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_alert_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_alert_settings resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_alert_settings resource.
  - name: alert_setting_name
    value: "{{ alert_setting_name }}"
    description: Required parameter for the replication_alert_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_alert_settings resource.
  - name: properties
    description: |
      The properties of a configure alert request.
    value:
      sendToOwners: "{{ sendToOwners }}"
      customEmailAddresses:
        - "{{ customEmailAddresses }}"
      locale: "{{ locale }}"