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

Success. The response describe the corresponding EmailService resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties of the service.
tags	object	Resource tags.

list_by_resource_group

Success. The response describes the list of EmailServices in a resourceGroup.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties of the service.
tags	object	Resource tags.

list_by_subscription

Success. The response describes the list of EmailServices in the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties of the service.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, emailServiceName		Get the EmailService and its properties.
list_by_resource_group	select	subscriptionId, resourceGroupName		Handles requests to list all resources in a resource group.
list_by_subscription	select	subscriptionId		Handles requests to list all resources in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, emailServiceName		Create a new EmailService or update an existing EmailService.
update	update	subscriptionId, resourceGroupName, emailServiceName		Operation to update an existing EmailService.
delete	delete	subscriptionId, resourceGroupName, emailServiceName		Operation to delete a EmailService.

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
emailServiceName	string	The name of the EmailService resource.
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.

SELECT examples

get

Get the EmailService and its properties.

SELECT
location,
properties,
tags
FROM azure.communication.email_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND emailServiceName = '{{ emailServiceName }}' -- required
;

list_by_resource_group

Handles requests to list all resources in a resource group.

SELECT
location,
properties,
tags
FROM azure.communication.email_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Handles requests to list all resources in a subscription.

SELECT
location,
properties,
tags
FROM azure.communication.email_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a new EmailService or update an existing EmailService.

INSERT INTO azure.communication.email_services (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
emailServiceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ emailServiceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: email_services
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the email_services resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the email_services resource.
    - name: emailServiceName
      value: string
      description: Required parameter for the email_services resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        The properties of the service.

UPDATE examples

update

Operation to update an existing EmailService.

UPDATE azure.communication.email_services
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND emailServiceName = '{{ emailServiceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Operation to delete a EmailService.

DELETE FROM azure.communication.email_services
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND emailServiceName = '{{ emailServiceName }}' --required
;