suppression_lists

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

Overview

Name	suppression_lists
Type	Resource
Id	azure.communication.suppression_lists

Fields

vw_suppression_lists

Name	Datatype	Description
created_time_stamp	text	field from the properties object
data_location	text	field from the properties object
domainName	text	field from the properties object
emailServiceName	text	field from the properties object
last_updated_time_stamp	text	field from the properties object
list_name	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
suppressionListName	text	field from the properties object

suppression_lists

Name	Datatype	Description
properties	object	A class that describes the properties of a SuppressionList resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	domainName, emailServiceName, resourceGroupName, subscriptionId, suppressionListName	Get a SuppressionList resource.
list_by_domain	SELECT	domainName, emailServiceName, resourceGroupName, subscriptionId	List all suppression lists for a domains resource.
create_or_update	INSERT	domainName, emailServiceName, resourceGroupName, subscriptionId, suppressionListName	Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.
delete	DELETE	domainName, emailServiceName, resourceGroupName, subscriptionId, suppressionListName	Delete a SuppressionList.

SELECT examples

List all suppression lists for a domains resource.

vw_suppression_lists

SELECT
created_time_stamp,
data_location,
domainName,
emailServiceName,
last_updated_time_stamp,
list_name,
resourceGroupName,
subscriptionId,
suppressionListName
FROM azure.communication.vw_suppression_lists
WHERE domainName = '{{ domainName }}'
AND emailServiceName = '{{ emailServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

suppression_lists

SELECT
properties
FROM azure.communication.suppression_lists
WHERE domainName = '{{ domainName }}'
AND emailServiceName = '{{ emailServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new suppression_lists resource.

All Properties

/*+ create */
INSERT INTO azure.communication.suppression_lists (
domainName,
emailServiceName,
resourceGroupName,
subscriptionId,
suppressionListName,
properties
)
SELECT 
'{{ domainName }}',
'{{ emailServiceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ suppressionListName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: listName
          value: string
        - name: lastUpdatedTimeStamp
          value: string
        - name: createdTimeStamp
          value: string
        - name: dataLocation
          value: string

DELETE example

Deletes the specified suppression_lists resource.

/*+ delete */
DELETE FROM azure.communication.suppression_lists
WHERE domainName = '{{ domainName }}'
AND emailServiceName = '{{ emailServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND suppressionListName = '{{ suppressionListName }}';