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

Success. The response describes the corresponding SuppressionList resource.

Name	Datatype	Description
properties	object	The properties of a SuppressionList resource.

list_by_domain

Success. The response describe the Domains SuppressionList resource collection.

Name	Datatype	Description
properties	object	The properties of a SuppressionList resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, emailServiceName, domainName, suppressionListName		Get a SuppressionList resource.
list_by_domain	select	subscriptionId, resourceGroupName, emailServiceName, domainName		List all suppression lists for a domains resource.
create_or_update	insert	subscriptionId, resourceGroupName, emailServiceName, domainName, suppressionListName		Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.
delete	delete	subscriptionId, resourceGroupName, emailServiceName, domainName, suppressionListName		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
domainName	string	The name of the Domains resource.
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.
suppressionListName	string	The name of the suppression list.

SELECT examples

get

Get a SuppressionList resource.

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

list_by_domain

List all suppression lists for a domains resource.

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

INSERT examples

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 (
data__properties,
subscriptionId,
resourceGroupName,
emailServiceName,
domainName,
suppressionListName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ emailServiceName }}',
'{{ domainName }}',
'{{ suppressionListName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: suppression_lists
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the suppression_lists resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the suppression_lists resource.
    - name: emailServiceName
      value: string
      description: Required parameter for the suppression_lists resource.
    - name: domainName
      value: string
      description: Required parameter for the suppression_lists resource.
    - name: suppressionListName
      value: string
      description: Required parameter for the suppression_lists resource.
    - name: properties
      value: object
      description: |
        The properties of a SuppressionList resource.

DELETE examples

delete

Delete a SuppressionList.

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