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

Success. The suppression list address object.

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

list

Success. The collection of SuppressionListAddresses for a SuppressionList.

Name	Datatype	Description
properties	object	The properties of a SuppressionListAddress 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, addressId		Get a SuppressionListAddress.
list	select	subscriptionId, resourceGroupName, emailServiceName, domainName, suppressionListName		Get all the addresses in a suppression list.
create_or_update	insert	subscriptionId, resourceGroupName, emailServiceName, domainName, suppressionListName, addressId		Create or update a SuppressionListAddress.
delete	delete	subscriptionId, resourceGroupName, emailServiceName, domainName, suppressionListName, addressId		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
addressId	string	The id of the address in a suppression list.
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 SuppressionListAddress.

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

list

Get all the addresses in a suppression list.

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

INSERT examples

create_or_update

Create or update a SuppressionListAddress.

INSERT INTO azure.communication.suppression_list_addresses (
data__properties,
subscriptionId,
resourceGroupName,
emailServiceName,
domainName,
suppressionListName,
addressId
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ emailServiceName }}',
'{{ domainName }}',
'{{ suppressionListName }}',
'{{ addressId }}'
RETURNING
properties
;

Manifest

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

DELETE examples

delete

Operation to delete a single address from a suppression list.

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