email_services

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

Overview

Name	email_services
Type	Resource
Id	azure.communication.email_services

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.
dataLocation	string	The location where the email service stores its data at rest. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
dataLocation	string	The location where the email service stores its data at rest. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
dataLocation	string	The location where the email service stores its data at rest. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving". (Unknown, Succeeded, Failed, Canceled, Running, Creating, Updating, Deleting, Moving)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, email_service_name, subscription_id		Get. Get the EmailService and its properties.
list_by_resource_group	select	resource_group_name, subscription_id		List By Resource Group. Handles requests to list all resources in a resource group.
list_by_subscription	select	subscription_id		List By Subscription. Handles requests to list all resources in a subscription.
create_or_update	insert	resource_group_name, email_service_name, subscription_id, location		Create Or Update. Create a new EmailService or update an existing EmailService.
update	update	resource_group_name, email_service_name, subscription_id		Update. Operation to update an existing EmailService.
create_or_update	replace	resource_group_name, email_service_name, subscription_id, location		Create Or Update. Create a new EmailService or update an existing EmailService.
delete	delete	resource_group_name, email_service_name, subscription_id		Delete. Operation to delete a EmailService.
list_verified_exchange_online_domains	exec	subscription_id		List Verified Domains From Exchange Online. Get a list of domains that are fully verified in Exchange Online.

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_service_name	string	The name of the EmailService resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get. Get the EmailService and its properties.

SELECT
id,
name,
dataLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure.communication.email_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List By Resource Group. Handles requests to list all resources in a resource group.

SELECT
id,
name,
dataLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure.communication.email_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List By Subscription. Handles requests to list all resources in a subscription.

SELECT
id,
name,
dataLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure.communication.email_services
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create Or Update. Create a new EmailService or update an existing EmailService.

INSERT INTO azure.communication.email_services (
tags,
location,
properties,
resource_group_name,
email_service_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ email_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: email_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the email_services resource.
  - name: email_service_name
    value: "{{ email_service_name }}"
    description: Required parameter for the email_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the email_services resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The properties of the service.
    value:
      provisioningState: "{{ provisioningState }}"
      dataLocation: "{{ dataLocation }}"

UPDATE examples

update

Update. Operation to update an existing EmailService.

UPDATE azure.communication.email_services
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create Or Update. Create a new EmailService or update an existing EmailService.

REPLACE azure.communication.email_services
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete. Operation to delete a EmailService.

DELETE FROM azure.communication.email_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_verified_exchange_online_domains

List Verified Domains From Exchange Online. Get a list of domains that are fully verified in Exchange Online.

EXEC azure.communication.email_services.list_verified_exchange_online_domains 
@subscription_id='{{ subscription_id }}' --required
;