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	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Alert related data.
type	string	Resource Type

list

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId, alertSettingName	api-version	Gets the details of the specified email notification(alert) configuration.
list	select	resourceName, resourceGroupName, subscriptionId	api-version	Gets the list of email notification(alert) configurations for the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, alertSettingName	api-version	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
alertSettingName	string	The name of the email notification(alert) configuration.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
api-version	string	Client Api Version.

SELECT examples

get

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

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_alert_settings
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND alertSettingName = '{{ alertSettingName }}' -- required
AND api-version = '{{ api-version }}'
;

list

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

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_alert_settings
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Create or update an email notification(alert) configuration.

INSERT INTO azure.recovery_services_site_recovery.replication_alert_settings (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
alertSettingName,
api-version
)
SELECT 
'{{ properties }}',
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ alertSettingName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_alert_settings
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_alert_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_alert_settings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_alert_settings resource.
    - name: alertSettingName
      value: string
      description: Required parameter for the replication_alert_settings resource.
    - name: properties
      value: object
      description: |
        The properties of a configure alert request.
    - name: api-version
      value: string
      description: Client Api Version.