suppression_list_addresses

Creates, updates, deletes, gets or lists a suppression_list_addresses resource.

Overview

Name	suppression_list_addresses
Type	Resource
Id	azure.communication.suppression_list_addresses

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 SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource.
email	string	Email address of the recipient. Required.
firstName	string	The first name of the email recipient.
lastModified	string (date-time)	The date the address was last updated in a suppression list.
lastName	string	The last name of the email recipient.
notes	string	An optional property to provide contextual notes or a description for an address.
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.
dataLocation	string	The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource.
email	string	Email address of the recipient. Required.
firstName	string	The first name of the email recipient.
lastModified	string (date-time)	The date the address was last updated in a suppression list.
lastName	string	The last name of the email recipient.
notes	string	An optional property to provide contextual notes or a description for an address.
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, email_service_name, domain_name, suppression_list_name, address_id, subscription_id		Get. Get a SuppressionListAddress.
list	select	resource_group_name, email_service_name, domain_name, suppression_list_name, subscription_id		Get. Get all the addresses in a suppression list.
create_or_update	insert	resource_group_name, email_service_name, domain_name, suppression_list_name, address_id, subscription_id		Create Or Update. Create or update a SuppressionListAddress.
create_or_update	replace	resource_group_name, email_service_name, domain_name, suppression_list_name, address_id, subscription_id		Create Or Update. Create or update a SuppressionListAddress.
delete	delete	resource_group_name, email_service_name, domain_name, suppression_list_name, address_id, subscription_id		Delete. Operation to delete a single address from a suppression list.

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
address_id	string	The id of the address in a suppression list. Required.
domain_name	string	The name of the Domains resource. Required.
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
suppression_list_name	string	The name of the suppression list. Required.

SELECT examples

get

Get. Get a SuppressionListAddress.

SELECT
id,
name,
dataLocation,
email,
firstName,
lastModified,
lastName,
notes,
systemData,
type
FROM azure.communication.suppression_list_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND suppression_list_name = '{{ suppression_list_name }}' -- required
AND address_id = '{{ address_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get. Get all the addresses in a suppression list.

SELECT
id,
name,
dataLocation,
email,
firstName,
lastModified,
lastName,
notes,
systemData,
type
FROM azure.communication.suppression_list_addresses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND suppression_list_name = '{{ suppression_list_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create Or Update. Create or update a SuppressionListAddress.

INSERT INTO azure.communication.suppression_list_addresses (
properties,
resource_group_name,
email_service_name,
domain_name,
suppression_list_name,
address_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ email_service_name }}',
'{{ domain_name }}',
'{{ suppression_list_name }}',
'{{ address_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: suppression_list_addresses
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the suppression_list_addresses resource.
  - name: email_service_name
    value: "{{ email_service_name }}"
    description: Required parameter for the suppression_list_addresses resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the suppression_list_addresses resource.
  - name: suppression_list_name
    value: "{{ suppression_list_name }}"
    description: Required parameter for the suppression_list_addresses resource.
  - name: address_id
    value: "{{ address_id }}"
    description: Required parameter for the suppression_list_addresses resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the suppression_list_addresses resource.
  - name: properties
    description: |
      The properties of a SuppressionListAddress resource.
    value:
      email: "{{ email }}"
      firstName: "{{ firstName }}"
      lastName: "{{ lastName }}"
      notes: "{{ notes }}"
      lastModified: "{{ lastModified }}"
      dataLocation: "{{ dataLocation }}"

REPLACE examples

create_or_update

Create Or Update. Create or update a SuppressionListAddress.

REPLACE azure.communication.suppression_list_addresses
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND suppression_list_name = '{{ suppression_list_name }}' --required
AND address_id = '{{ address_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete. Operation to delete a single address from a suppression list.

DELETE FROM azure.communication.suppression_list_addresses
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND email_service_name = '{{ email_service_name }}' --required
AND domain_name = '{{ domain_name }}' --required
AND suppression_list_name = '{{ suppression_list_name }}' --required
AND address_id = '{{ address_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;