suppression_lists

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

Overview

Name	suppression_lists
Type	Resource
Id	azure.communication.suppression_lists

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.
createdTimeStamp	string	The date the resource was created.
dataLocation	string	The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource.
lastUpdatedTimeStamp	string	The date the resource was last updated.
listName	string	The name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
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_by_domain

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.
createdTimeStamp	string	The date the resource was created.
dataLocation	string	The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource.
lastUpdatedTimeStamp	string	The date the resource was last updated.
listName	string	The name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
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, subscription_id		Get. Get a SuppressionList resource.
list_by_domain	select	resource_group_name, email_service_name, domain_name, subscription_id		List. List all suppression lists for a domains resource.
create_or_update	insert	resource_group_name, email_service_name, domain_name, suppression_list_name, subscription_id		Create Or Update. Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.
create_or_update	replace	resource_group_name, email_service_name, domain_name, suppression_list_name, subscription_id		Create Or Update. Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.
delete	delete	resource_group_name, email_service_name, domain_name, suppression_list_name, subscription_id		Delete. Delete a SuppressionList.

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
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 SuppressionList resource.

SELECT
id,
name,
createdTimeStamp,
dataLocation,
lastUpdatedTimeStamp,
listName,
systemData,
type
FROM azure.communication.suppression_lists
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
;

list_by_domain

List. List all suppression lists for a domains resource.

SELECT
id,
name,
createdTimeStamp,
dataLocation,
lastUpdatedTimeStamp,
listName,
systemData,
type
FROM azure.communication.suppression_lists
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND email_service_name = '{{ email_service_name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create Or Update. Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.

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

Manifest

# Description fields are for documentation purposes
- name: suppression_lists
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the suppression_lists resource.
  - name: email_service_name
    value: "{{ email_service_name }}"
    description: Required parameter for the suppression_lists resource.
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the suppression_lists resource.
  - name: suppression_list_name
    value: "{{ suppression_list_name }}"
    description: Required parameter for the suppression_lists resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the suppression_lists resource.
  - name: properties
    description: |
      The properties of a SuppressionList resource.
    value:
      listName: "{{ listName }}"
      lastUpdatedTimeStamp: "{{ lastUpdatedTimeStamp }}"
      createdTimeStamp: "{{ createdTimeStamp }}"
      dataLocation: "{{ dataLocation }}"

REPLACE examples

create_or_update

Create Or Update. Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.

REPLACE azure.communication.suppression_lists
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete. Delete a SuppressionList.

DELETE FROM azure.communication.suppression_lists
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
;