Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. communication
  5. getSuppressionList
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.communication.getSuppressionList

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a SuppressionList resource. Azure REST API version: 2023-06-01-preview.

Using getSuppressionList

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSuppressionList(args: GetSuppressionListArgs, opts?: InvokeOptions): Promise<GetSuppressionListResult>
function getSuppressionListOutput(args: GetSuppressionListOutputArgs, opts?: InvokeOptions): Output<GetSuppressionListResult>
Copy
def get_suppression_list(domain_name: Optional[str] = None,
                         email_service_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         suppression_list_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSuppressionListResult
def get_suppression_list_output(domain_name: Optional[pulumi.Input[str]] = None,
                         email_service_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         suppression_list_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSuppressionListResult]
Copy
func LookupSuppressionList(ctx *Context, args *LookupSuppressionListArgs, opts ...InvokeOption) (*LookupSuppressionListResult, error)
func LookupSuppressionListOutput(ctx *Context, args *LookupSuppressionListOutputArgs, opts ...InvokeOption) LookupSuppressionListResultOutput
Copy

> Note: This function is named LookupSuppressionList in the Go SDK.

public static class GetSuppressionList 
{
    public static Task<GetSuppressionListResult> InvokeAsync(GetSuppressionListArgs args, InvokeOptions? opts = null)
    public static Output<GetSuppressionListResult> Invoke(GetSuppressionListInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSuppressionListResult> getSuppressionList(GetSuppressionListArgs args, InvokeOptions options)
public static Output<GetSuppressionListResult> getSuppressionList(GetSuppressionListArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:communication:getSuppressionList
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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.
SuppressionListName
This property is required.
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.
SuppressionListName
This property is required.
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.
suppressionListName
This property is required.
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.
suppressionListName
This property is required.
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.
suppression_list_name
This property is required.
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.
suppressionListName
This property is required.
Changes to this property will trigger replacement.
String
The name of the suppression list.

getSuppressionList Result

The following output properties are available:

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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
ListName string
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
ListName string
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
listName String
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
listName string
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
list_name str
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
listName String
The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain.

Supporting Types

SystemDataResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native