email_configurations

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

Overview

Name	email_configurations
Type	Resource
Id	azure.data_replication.email_configurations

Fields

The following fields are returned by SELECT queries:

get

Returns EmailConfiguration Model on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Email configuration model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

list

Returns EmailConfiguration Model Collection on success.

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
properties	object	Email configuration model properties.
systemData	object	System data required to be defined for Azure resources.
type	string	Gets or sets the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, emailConfigurationName		Gets the details of the alert configuration setting.
list	select	subscriptionId, resourceGroupName, vaultName		Gets the list of alert configuration settings for the given vault.
create	insert	subscriptionId, resourceGroupName, vaultName, emailConfigurationName, data__properties		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
emailConfigurationName	string	The email configuration name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The vault name.

SELECT examples

get

Gets the details of the alert configuration setting.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.email_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND emailConfigurationName = '{{ emailConfigurationName }}' -- required
;

list

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_replication.email_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

INSERT examples

create

Creates an alert configuration setting for the given vault.

INSERT INTO azure.data_replication.email_configurations (
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
emailConfigurationName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ emailConfigurationName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: email_configurations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the email_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the email_configurations resource.
    - name: vaultName
      value: string
      description: Required parameter for the email_configurations resource.
    - name: emailConfigurationName
      value: string
      description: Required parameter for the email_configurations resource.
    - name: properties
      value: object
      description: |
        Email configuration model properties.