email_configuration

Creates, updates, deletes, gets or lists an email_configuration resource.

Overview

Name	email_configuration
Type	Resource
Id	azure.recovery_services_data_replication.email_configuration

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	Gets or sets the custom email address for sending emails.
locale	string	Gets or sets the locale for the email notification.
provisioningState	string	Gets or sets the provisioning state of the email configuration. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
sendToOwners	boolean	Gets or sets a value indicating whether to send email to subscription administrator. Required.
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	Gets or sets the custom email address for sending emails.
locale	string	Gets or sets the locale for the email notification.
provisioningState	string	Gets or sets the provisioning state of the email configuration. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
sendToOwners	boolean	Gets or sets a value indicating whether to send email to subscription administrator. Required.
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, vault_name, email_configuration_name, subscription_id		Gets the details of the alert configuration setting.
list	select	resource_group_name, vault_name, subscription_id		Gets the list of alert configuration settings for the given vault.
create	insert	resource_group_name, vault_name, email_configuration_name, subscription_id		Creates an alert configuration setting for the given vault.

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
email_configuration_name	string	The email configuration name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The vault name. Required.

SELECT examples

get

Gets the details of the alert configuration setting.

SELECT
id,
name,
customEmailAddresses,
locale,
provisioningState,
sendToOwners,
systemData,
type
FROM azure.recovery_services_data_replication.email_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND email_configuration_name = '{{ email_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of alert configuration settings for the given vault.

SELECT
id,
name,
customEmailAddresses,
locale,
provisioningState,
sendToOwners,
systemData,
type
FROM azure.recovery_services_data_replication.email_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates an alert configuration setting for the given vault.

INSERT INTO azure.recovery_services_data_replication.email_configuration (
properties,
resource_group_name,
vault_name,
email_configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ email_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: email_configuration
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the email_configuration resource.
  - name: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the email_configuration resource.
  - name: email_configuration_name
    value: "{{ email_configuration_name }}"
    description: Required parameter for the email_configuration resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the email_configuration resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      sendToOwners: {{ sendToOwners }}
      customEmailAddresses:
        - "{{ customEmailAddresses }}"
      locale: "{{ locale }}"
      provisioningState: "{{ provisioningState }}"