Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. communication
  5. SuppressionList
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.communication.SuppressionList

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

A class representing a SuppressionList resource.

Uses Azure REST API version 2023-06-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-06-01-preview.

Other available API versions: 2024-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native communication [ApiVersion]. See the version guide for details.

Example Usage

CreateOrUpdate SuppressionLists resource.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var suppressionList = new AzureNative.Communication.SuppressionList("suppressionList", new()
    {
        DomainName = "contoso.com",
        EmailServiceName = "contosoEmailService",
        ListName = "contosoNewsAlerts",
        ResourceGroupName = "contosoResourceGroup",
        SuppressionListName = "aaaa1111-bbbb-2222-3333-aaaa11112222",
    });

});
Copy
package main

import (
	communication "github.com/pulumi/pulumi-azure-native-sdk/communication/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := communication.NewSuppressionList(ctx, "suppressionList", &communication.SuppressionListArgs{
			DomainName:          pulumi.String("contoso.com"),
			EmailServiceName:    pulumi.String("contosoEmailService"),
			ListName:            pulumi.String("contosoNewsAlerts"),
			ResourceGroupName:   pulumi.String("contosoResourceGroup"),
			SuppressionListName: pulumi.String("aaaa1111-bbbb-2222-3333-aaaa11112222"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.communication.SuppressionList;
import com.pulumi.azurenative.communication.SuppressionListArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var suppressionList = new SuppressionList("suppressionList", SuppressionListArgs.builder()
            .domainName("contoso.com")
            .emailServiceName("contosoEmailService")
            .listName("contosoNewsAlerts")
            .resourceGroupName("contosoResourceGroup")
            .suppressionListName("aaaa1111-bbbb-2222-3333-aaaa11112222")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const suppressionList = new azure_native.communication.SuppressionList("suppressionList", {
    domainName: "contoso.com",
    emailServiceName: "contosoEmailService",
    listName: "contosoNewsAlerts",
    resourceGroupName: "contosoResourceGroup",
    suppressionListName: "aaaa1111-bbbb-2222-3333-aaaa11112222",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

suppression_list = azure_native.communication.SuppressionList("suppressionList",
    domain_name="contoso.com",
    email_service_name="contosoEmailService",
    list_name="contosoNewsAlerts",
    resource_group_name="contosoResourceGroup",
    suppression_list_name="aaaa1111-bbbb-2222-3333-aaaa11112222")
Copy
resources:
  suppressionList:
    type: azure-native:communication:SuppressionList
    properties:
      domainName: contoso.com
      emailServiceName: contosoEmailService
      listName: contosoNewsAlerts
      resourceGroupName: contosoResourceGroup
      suppressionListName: aaaa1111-bbbb-2222-3333-aaaa11112222
Copy

Create SuppressionList Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SuppressionList(name: string, args: SuppressionListArgs, opts?: CustomResourceOptions);
@overload
def SuppressionList(resource_name: str,
                    args: SuppressionListArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SuppressionList(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    domain_name: Optional[str] = None,
                    email_service_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    list_name: Optional[str] = None,
                    suppression_list_name: Optional[str] = None)
func NewSuppressionList(ctx *Context, name string, args SuppressionListArgs, opts ...ResourceOption) (*SuppressionList, error)
public SuppressionList(string name, SuppressionListArgs args, CustomResourceOptions? opts = null)
public SuppressionList(String name, SuppressionListArgs args)
public SuppressionList(String name, SuppressionListArgs args, CustomResourceOptions options)

type: azure-native:communication:SuppressionList
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SuppressionListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SuppressionListArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SuppressionListArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SuppressionListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SuppressionListArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var suppressionListResource = new AzureNative.Communication.SuppressionList("suppressionListResource", new()
{
    DomainName = "string",
    EmailServiceName = "string",
    ResourceGroupName = "string",
    ListName = "string",
    SuppressionListName = "string",
});
Copy
example, err := communication.NewSuppressionList(ctx, "suppressionListResource", &communication.SuppressionListArgs{
	DomainName:          pulumi.String("string"),
	EmailServiceName:    pulumi.String("string"),
	ResourceGroupName:   pulumi.String("string"),
	ListName:            pulumi.String("string"),
	SuppressionListName: pulumi.String("string"),
})
Copy
var suppressionListResource = new SuppressionList("suppressionListResource", SuppressionListArgs.builder()
    .domainName("string")
    .emailServiceName("string")
    .resourceGroupName("string")
    .listName("string")
    .suppressionListName("string")
    .build());
Copy
suppression_list_resource = azure_native.communication.SuppressionList("suppressionListResource",
    domain_name="string",
    email_service_name="string",
    resource_group_name="string",
    list_name="string",
    suppression_list_name="string")
Copy
const suppressionListResource = new azure_native.communication.SuppressionList("suppressionListResource", {
    domainName: "string",
    emailServiceName: "string",
    resourceGroupName: "string",
    listName: "string",
    suppressionListName: "string",
});
Copy
type: azure-native:communication:SuppressionList
properties:
    domainName: string
    emailServiceName: string
    listName: string
    resourceGroupName: string
    suppressionListName: string
Copy

SuppressionList Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SuppressionList resource accepts the following input properties:

DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Domains resource.
EmailServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the EmailService resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ListName string
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
SuppressionListName Changes to this property will trigger replacement. string
The name of the suppression list.
DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Domains resource.
EmailServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the EmailService resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ListName string
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
SuppressionListName Changes to this property will trigger replacement. string
The name of the suppression list.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Domains resource.
emailServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the EmailService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
listName String
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
suppressionListName Changes to this property will trigger replacement. String
The name of the suppression list.
domainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Domains resource.
emailServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the EmailService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
listName string
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
suppressionListName Changes to this property will trigger replacement. string
The name of the suppression list.
domain_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Domains resource.
email_service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the EmailService resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
list_name str
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
suppression_list_name Changes to this property will trigger replacement. str
The name of the suppression list.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Domains resource.
emailServiceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the EmailService resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
listName String
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
suppressionListName Changes to this property will trigger replacement. String
The name of the suppression list.

Outputs

All input properties are implicitly available as output properties. Additionally, the SuppressionList resource produces the following output properties:

AzureApiVersion string
The Azure API version 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.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedTimeStamp string
The date the resource was last updated.
Name string
The name of the resource
SystemData Pulumi.AzureNative.Communication.Outputs.SystemDataResponse
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"
AzureApiVersion string
The Azure API version 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.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedTimeStamp string
The date the resource was last updated.
Name string
The name of the resource
SystemData SystemDataResponse
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"
azureApiVersion String
The Azure API version 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.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedTimeStamp String
The date the resource was last updated.
name String
The name of the resource
systemData SystemDataResponse
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"
azureApiVersion string
The Azure API version 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.
id string
The provider-assigned unique ID for this managed resource.
lastUpdatedTimeStamp string
The date the resource was last updated.
name string
The name of the resource
systemData SystemDataResponse
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"
azure_api_version str
The Azure API version of the resource.
created_time_stamp str
The date the resource was created.
data_location str
The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource.
id str
The provider-assigned unique ID for this managed resource.
last_updated_time_stamp str
The date the resource was last updated.
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version 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.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedTimeStamp String
The date the resource was last updated.
name String
The name of the resource
systemData Property Map
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"

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:communication:SuppressionList aaaa1111-bbbb-2222-3333-aaaa11112222 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native