Dela via


Snabbstart: Hantera domänundertryckningslistor i Azure Communication Services med hjälp av hanteringsklientbiblioteken

Viktigt!

Funktioner som beskrivs i den här artikeln är för närvarande i offentlig förhandsversion. Den här förhandsversionen tillhandahålls utan ett serviceavtal och vi rekommenderar det inte för produktionsarbetsbelastningar. Vissa funktioner kanske inte stöds eller kan vara begränsade. Mer information finns i Kompletterande villkor för användning av Microsoft Azure-förhandsversioner.

Den här snabbstarten beskriver processen för att hantera domänundertryckningslistor i Azure Communication Services med hjälp av klientbiblioteken för Azure Communication Services-hantering.

Förutsättningar

Installera de paket som krävs

dotnet add package Azure.ResourceManager.Communication
dotnet add package Azure.Identity

Initiera hanteringsklienten

Ange miljövariabeln AZURE_SUBSCRIPTION_ID med prenumerations-ID för prenumerationen som domän- och e-postresurserna finns i. Kör kodexemplet för att initiera hanteringsklienten.

using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Communication;

ArmClient client = new ArmClient(new DefaultAzureCredential());

Lägga till en undertryckningslista i en domänresurs

För att blockera att dina e-postmeddelanden skickas till vissa adresser är det första steget att konfigurera en undertryckningslista i domänresursen.

Uppdatera kodexemplet med resursgruppens namn, e-posttjänstnamnet och domännamnet som du vill skapa undertryckningslistan för. Hitta den här informationen i portalen genom att gå till den domänresurs som du skapade när du konfigurerade förutsättningarna. Resursens rubrik är <your-email-service-name>/<your-domain-name>. Leta reda på resursgruppens namn och prenumerations-ID i avsnitten Essentials i översikten över domänresursen. Välj valfritt namn på undertryckningslistresursen och uppdatera även fältet i exemplet.

För listnamnet kontrollerar du att det är samma som avsändarens användarnamn för MailFrom-adressen som du vill utelämna e-postmeddelanden från. Dessa MailFrom-adresser finns i avsnittet "MailFrom addresses" i domänresursen i portalen. Du kan till exempel ha en MailFrom-adress som ser ut som "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Avsändarens användarnamn för den här adressen skulle vara "donotreply" så ett listnamn på "donotreply" ska användas.

Kodexemplet skapar undertryckningslistan och lagrar den i variabeln suppressionListResource för framtida åtgärder.

string subscriptionId = "<your-subscription-id>"; // Found in the essentials section of the domain resource portal overview
string resourceGroupName = "<your-resource-group-name>"; // Found in the essentials section of the domain resource portal overview
string emailServiceName = "<your-email-service-name>"; // Found in the first part of the portal domain resource title
string domainResourceName = "<your-domain-name>"; // Found in the second part of the portal domain resource title
string suppressionListResourceName = "<your-suppression-list-resource-name>";

ResourceIdentifier suppressionListResourceId = SuppressionListResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, emailServiceName, domainResourceName, suppressionListResourceName);
SuppressionListResource suppressionListResource = client.GetSuppressionListResource(suppressionListResourceId);

SuppressionListResourceData suppressionListData = new SuppressionListResourceData()
{
    ListName = "<your-sender-username>", // Should match the sender username of the MailFrom address you would like to suppress emails from
};

suppressionListResource.Update(WaitUntil.Completed, suppressionListData);

Om du vill utelämna e-postmeddelanden från alla avsändares användarnamn i en viss domän kan du skicka in en tom sträng för listnamnet.

SuppressionListResourceData suppressionListData = new SuppressionListResourceData()
{
    ListName = "",
};

suppressionListResource.Update(WaitUntil.Completed, suppressionListData);

Lägga till en adress i en undertryckningslista

När du har konfigurerat undertryckningslistan kan du nu lägga till specifika e-postadresser som du vill förhindra att dina e-postmeddelanden skickas till.

Uppdatera kodexemplet med undertryckningslistans adress-ID. Varje undertryckningslistas adress-ID som du lägger till måste vara unikt. Vi rekommenderar att du använder ett GUID. Uppdatera den e-postadress som du vill blockera från att ta emot dina meddelanden också.

Om du vill lägga till flera adresser i undertryckningslistan måste du upprepa det här kodexemplet flera gånger.

string suppressionListAddressId = "<your-suppression-list-address-id>";

ResourceIdentifier suppressionListAddressResourceId = SuppressionListAddressResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, emailServiceName, domainResourceName, suppressionListResourceName, suppressionListAddressId);
SuppressionListAddressResource suppressionListAddressResource = client.GetSuppressionListAddressResource(suppressionListAddressResourceId);

SuppressionListAddressResourceData suppressionListAddressData = new SuppressionListAddressResourceData()
{
    Email = "<email-address-to-suppress>" // Should match the email address you would like to block from receiving your messages
};

suppressionListAddressResource.Update(WaitUntil.Completed, suppressionListAddressData);

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du har valt att ignorera. E-postmeddelandet skickas inte till den undertryckta adressen.

Om du försöker skicka ett e-postmeddelande från ett avsändaranvändaranvändarnamn som inte ignoreras skickas e-postmeddelandet fortfarande.

Ta bort en adress från en undertryckningslista

Om du vill ta bort en adress från undertryckningslistan skapar SuppressionListAddressResource du som du ser i föregående kodexempel och anropar Delete metoden.

suppressionListAddressResource.Delete(WaitUntil.Completed);

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du väljer att utelämna. E-postmeddelandet skickas till den tidigare undertryckta adressen.

Ta bort en undertryckningslista från en domänresurs

Om du vill ta bort en undertryckningslista från domänresursen SuppressionListResource skapar du som du ser i föregående kodexempel och anropar Delete metoden.

suppressionListResource.Delete(WaitUntil.Completed);

Förutsättningar

Installera de paket som krävs

npm install @azure/arm-communication
npm install @azure/identity

Initiera hanteringsklienten

Ersätt fältet i exempelkoden med prenumerations-ID:t för prenumerationen som dina domän- och e-postresurser finns i. Kör kodexemplet för att initiera hanteringsklienten.

const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

const credential = new DefaultAzureCredential();
const subscriptionId = "<your-subscription-id>";

const client = new CommunicationServiceManagementClient(credential, subscriptionId);

Lägga till en undertryckningslista i en domänresurs

För att blockera att dina e-postmeddelanden skickas till vissa adresser är det första steget att konfigurera en undertryckningslista i domänresursen.

Uppdatera kodexemplet med resursgruppens namn, e-posttjänstnamnet och domännamnet som du vill skapa undertryckningslistan för. Hitta den här informationen i portalen genom att gå till den domänresurs som du skapade när du konfigurerade förutsättningarna. Resursens rubrik är <your-email-service-name>/<your-domain-name>. Leta reda på resursgruppens namn och prenumerations-ID i avsnitten Essentials i översikten över domänresursen. Välj valfritt namn på undertryckningslistresursen och uppdatera även fältet i exemplet.

För listnamnet kontrollerar du att det är samma som avsändarens användarnamn för MailFrom-adressen som du vill utelämna e-postmeddelanden från. Dessa MailFrom-adresser finns i avsnittet "MailFrom addresses" i domänresursen i portalen. Du kan till exempel ha en MailFrom-adress som ser ut som "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Avsändarens användarnamn för den här adressen skulle vara "donotreply" så ett listnamn på "donotreply" ska användas.

const resourceGroupName = "<your-resource-group-name>"; // Found in the essentials section of the domain resource portal overview
const emailServiceName = "<your-email-service-name>"; // Found in the first part of the portal domain resource title
const domainResourceName = "<your-domain-name>"; // Found in the second part of the portal domain resource title
const suppressionListResourceName = "<your-suppression-list-resource-name>";

parameters = { 
    "listName": "<your-sender-username>", // Should match the sender username of the MailFrom address you would like to suppress emails from
}

await client.suppressionLists.createOrUpdate(
    resourceGroupName,
    emailServiceName,
    domainResourceName,
    suppressionListResourceName,
    parameters
);

Om du vill utelämna e-postmeddelanden från alla avsändares användarnamn i en viss domän kan du skicka in en tom sträng för listnamnet.

parameters = { 
    "listName": "",
}

await client.suppressionLists.createOrUpdate(
    resourceGroupName,
    emailServiceName,
    domainResourceName,
    suppressionListResourceName,
    parameters
);

Lägga till en adress i en undertryckningslista

När du har konfigurerat undertryckningslistan kan du nu lägga till specifika e-postadresser som du vill förhindra att dina e-postmeddelanden skickas till.

Uppdatera kodexemplet med undertryckningslistans adress-ID. Varje undertryckningslistas adress-ID som du lägger till måste vara unikt. Vi rekommenderar att du använder ett GUID. Uppdatera den e-postadress som du vill blockera från att ta emot dina meddelanden också.

Om du vill lägga till flera adresser i undertryckningslistan måste du upprepa det här kodexemplet flera gånger.

const suppressionListAddressId = "<your-suppression-list-address-id>";

parameters = { 
    "email": "<email-address-to-suppress>" // Should match the email address you would like to block from receiving your messages
}

await client.suppressionListAddresses.createOrUpdate(
    resourceGroupName,
    emailServiceName,
    domainResourceName,
    suppressionListResourceName,
    suppressionListAddressId,
    parameters
);

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du har valt att ignorera. E-postmeddelandet skickas inte till den undertryckta adressen.

Om du försöker skicka ett e-postmeddelande från ett avsändaranvändaranvändarnamn som inte ignoreras skickas e-postmeddelandet fortfarande.

Ta bort en adress från en undertryckningslista

delete Anropa metoden på suppressionListAddresses för att ta bort en adress från undertryckningslistan.

await client.suppressionListAddresses.delete(
    resourceGroupName,
    emailServiceName,
    domainResourceName,
    suppressionListResourceName,
    suppressionListAddressId
);

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du väljer att utelämna. E-postmeddelandet skickas till den tidigare undertryckta adressen.

Ta bort en undertryckningslista från en domänresurs

delete Anropa metoden på suppressionList för att ta bort en undertryckningslista från domänresursen.

await client.suppressionLists.delete(
    resourceGroupName,
    emailServiceName,
    domainResourceName,
    suppressionListResourceName
);

Förutsättningar

Installera de paket som krävs

Lägg till följande beroenden i .pom.xml

<dependency>
    <groupId>com.azure.resourcemanager</groupId>
    <artifactId>azure-resourcemanager-communication</artifactId>
    <version>2.2.0</version>
</dependency>
<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.11.1</version>
</dependency>

Initiera hanteringsklienten

Ange miljövariabeln AZURE_SUBSCRIPTION_ID med prenumerations-ID för prenumerationen som domän- och e-postresurserna finns i.

Lägg till följande importer överst i filen.

import com.azure.core.credential.TokenCredential;
import com.azure.core.management.AzureEnvironment;
import com.azure.core.management.profile.AzureProfile;
import com.azure.identity.DefaultAzureCredentialBuilder;
import com.azure.resourcemanager.communication.CommunicationManager;

Kör kodexemplet för att initiera hanteringsklienten.

AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
TokenCredential credential = new DefaultAzureCredentialBuilder()
        .authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
        .build();

CommunicationManager manager = CommunicationManager
        .authenticate(credential, profile);

Lägga till en undertryckningslista i en domänresurs

För att blockera att dina e-postmeddelanden skickas till vissa adresser är det första steget att konfigurera en undertryckningslista i domänresursen.

Uppdatera kodexemplet med resursgruppens namn, e-posttjänstnamnet och domännamnet som du vill skapa undertryckningslistan för. Hitta den här informationen i portalen genom att gå till den domänresurs som du skapade när du konfigurerade förutsättningarna. Resursens rubrik är <your-email-service-name>/<your-domain-name>. Leta reda på resursgruppens namn och prenumerations-ID i avsnitten Essentials i översikten över domänresursen. Välj valfritt namn på undertryckningslistresursen och uppdatera även fältet i exemplet.

För listnamnet kontrollerar du att det är samma som avsändarens användarnamn för MailFrom-adressen som du vill utelämna e-postmeddelanden från. Dessa MailFrom-adresser finns i avsnittet "MailFrom addresses" i domänresursen i portalen. Du kan till exempel ha en MailFrom-adress som ser ut som "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Avsändarens användarnamn för den här adressen skulle vara "donotreply" så ett listnamn på "donotreply" ska användas.

String resourceGroupName = "<your-resource-group-name>"; // Found in the essentials section of the domain resource portal overview
String emailServiceName = "<your-email-service-name>"; // Found in the first part of the portal domain resource title
String domainResourceName = "<your-domain-name>"; // Found in the second part of the portal domain resource title
String suppressionListResourceName = "<your-suppression-list-resource-name>";

manager.suppressionLists().define(suppressionListResourceName)
    .withExistingDomain(resourceGroupName, emailServiceName, domainResourceName)
    .withListName("<your-sender-username>") // Should match the sender username of the MailFrom address you would like to suppress emails from
    .create();

Om du vill utelämna e-postmeddelanden från alla avsändares användarnamn i en viss domän kan du skicka in en tom sträng för listnamnet.

manager.suppressionLists().define(suppressionListResourceName)
    .withExistingDomain(resourceGroupName, emailServiceName, domainResourceName)
    .withListName("")
    .create();

Lägga till en adress i en undertryckningslista

När du har konfigurerat undertryckningslistan kan du nu lägga till specifika e-postadresser som du vill förhindra att dina e-postmeddelanden skickas till.

Uppdatera kodexemplet med undertryckningslistans adress-ID. Varje undertryckningslistas adress-ID som du lägger till måste vara unikt. Vi rekommenderar att du använder ett GUID. Uppdatera den e-postadress som du vill blockera från att ta emot dina meddelanden också.

Om du vill lägga till flera adresser i undertryckningslistan måste du upprepa det här kodexemplet flera gånger.

String suppressionListAddressId = "<your-suppression-list-address-id>";

manager.suppressionListAddresses().define(suppressionListAddressId)
    .withExistingSuppressionList(resourceGroupName, emailServiceName, domainResourceName, suppressionListResourceName)
    .withEmail("<email-address-to-suppress>") // Should match the email address you would like to block from receiving your messages
    .create();

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du har valt att ignorera. E-postmeddelandet skickas inte till den undertryckta adressen.

Om du försöker skicka ett e-postmeddelande från ett avsändaranvändaranvändarnamn som inte ignoreras skickas e-postmeddelandet fortfarande.

Ta bort en adress från en undertryckningslista

delete Anropa metoden på suppressionListAddresses för att ta bort en adress från undertryckningslistan.

manager.suppressionListAddresses()
    .delete(resourceGroupName, emailServiceName, domainResourceName, suppressionListResourceName, suppressionListAddressId);

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du väljer att utelämna. E-postmeddelandet skickas till den tidigare undertryckta adressen.

Ta bort en undertryckningslista från en domänresurs

delete Anropa metoden på suppressionLists för att ta bort en undertryckningslista från domänresursen.

manager.suppressionLists()
    .delete(resourceGroupName, emailServiceName, domainResourceName, suppressionListResourceName);

Förutsättningar

Installera de paket som krävs

pip install azure-mgmt-communication
pip install azure-identity

Initiera hanteringsklienten

Ange miljövariabeln AZURE_SUBSCRIPTION_ID med prenumerations-ID för prenumerationen som domän- och e-postresurserna finns i. Kör kodexemplet för att initiera hanteringsklienten.

from azure.mgmt.communication import CommunicationServiceManagementClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
subscription_id = "<your-subscription-id>"

mgmt_client = CommunicationServiceManagementClient(credential, subscription_id)

Lägga till en undertryckningslista i en domänresurs

För att blockera att dina e-postmeddelanden skickas till vissa adresser är det första steget att konfigurera en undertryckningslista i domänresursen.

Uppdatera kodexemplet med resursgruppens namn, e-posttjänstnamnet och domännamnet som du vill skapa undertryckningslistan för. Hitta den här informationen i portalen genom att gå till den domänresurs som du skapade när du konfigurerade förutsättningarna. Resursens rubrik är <your-email-service-name>/<your-domain-name>. Leta reda på resursgruppens namn och prenumerations-ID i avsnitten Essentials i översikten över domänresursen. Välj valfritt namn på undertryckningslistresursen och uppdatera även fältet i exemplet.

För listnamnet kontrollerar du att det är samma som avsändarens användarnamn för MailFrom-adressen som du vill utelämna e-postmeddelanden från. Dessa MailFrom-adresser finns i avsnittet "MailFrom addresses" i domänresursen i portalen. Du kan till exempel ha en MailFrom-adress som ser ut som "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Avsändarens användarnamn för den här adressen skulle vara "donotreply" så ett listnamn på "donotreply" ska användas.

resource_group_name = "<your-resource-group-name>"; # Found in the essentials section of the domain resource portal overview
email_service_name = "<your-email-service-name>"; # Found in the first part of the portal domain resource title
domain_resource_name = "<your-domain-name>"; # Found in the second part of the portal domain resource title
suppression_list_resource_name = "<your-suppression-list-resource-name>";

mgmt_client.suppression_lists.create_or_update(
    resource_group_name,
    email_service_name,
    domain_resource_name,
    suppression_list_resource_name,
    parameters={
        "properties": {
            "listName": "<your-sender-username>" # Should match the sender username of the MailFrom address you would like to suppress emails from
        }
    },
)

Om du vill utelämna e-postmeddelanden från alla avsändares användarnamn i en viss domän kan du skicka in en tom sträng för listnamnet.

mgmt_client.suppression_lists.create_or_update(
    resource_group_name,
    email_service_name,
    domain_resource_name,
    suppression_list_resource_name,
    parameters={
        "properties": {
            "listName": ""
        }
    },
)

Lägga till en adress i en undertryckningslista

När du har konfigurerat undertryckningslistan kan du nu lägga till specifika e-postadresser som du vill förhindra att dina e-postmeddelanden skickas till.

Uppdatera kodexemplet med undertryckningslistans adress-ID. Varje undertryckningslistas adress-ID som du lägger till måste vara unikt. Vi rekommenderar att du använder ett GUID. Uppdatera den e-postadress som du vill blockera från att ta emot dina meddelanden också.

Om du vill lägga till flera adresser i undertryckningslistan måste du upprepa det här kodexemplet flera gånger.

suppression_list_address_id = "<your-suppression-list-address-id>";

mgmt_client.suppression_list_addresses.create_or_update(
    resource_group_name,
    email_service_name,
    domain_resource_name,
    suppression_list_resource_name,
    suppression_list_address_id,
    parameters={
        "properties": {
            "email": "<email-address-to-suppress>" # Should match the email address you would like to block from receiving your messages
        }
    },
)

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du väljer att utelämna. E-postmeddelandet skickas inte till den undertryckta adressen.

Om du försöker skicka ett e-postmeddelande från ett avsändaranvändaranvändarnamn som inte ignoreras skickas e-postmeddelandet fortfarande.

Ta bort en adress från en undertryckningslista

delete Anropa metoden på suppression_list_addresses för att ta bort en adress från undertryckningslistan.

mgmt_client.suppression_list_addresses.delete(
    resource_group_name,
    email_service_name,
    domain_resource_name,
    suppression_list_resource_name,
    suppression_list_address_id
)

Nu kan du försöka skicka ett e-postmeddelande till den undertryckta adressen från TryEmail avsnittet i kommunikationstjänstens resurs eller med hjälp av någon av E-post-SDK:erna. Se till att skicka e-postmeddelandet med hjälp av MailFrom-adressen med det avsändaranvändaranvändarnamn som du har valt att ignorera. E-postmeddelandet skickas till den tidigare undertryckta adressen.

Ta bort en undertryckningslista från en domänresurs

delete Anropa metoden på suppression_lists för att ta bort en undertryckningslista från domänresursen.

mgmt_client.suppression_lists.delete(
    resource_group_name,
    email_service_name,
    domain_resource_name,
    suppression_list_resource_name
)