Partager via

Démarrage rapide : gérer les listes de suppression de domaine dans Azure Communication Services à l’aide des bibliothèques de client de gestion

  • Article

Important

Les fonctionnalités décrites dans cet article sont actuellement en préversion publique. Cette préversion est fournie sans contrat de niveau de service et n’est pas recommandée pour les charges de travail de production. Certaines fonctionnalités peuvent être limitées ou non prises en charge. Pour plus d’informations, consultez Conditions d’Utilisation Supplémentaires relatives aux Évaluations Microsoft Azure.

Ce guide de démarrage rapide décrit le processus de gestion des listes de suppression de domaine dans Azure Communication Services à l’aide des bibliothèques de client de gestion Azure Communication Services.

Prérequis

Installer les packages requis

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

Initialiser le client de gestion

Définissez la variable d’environnement AZURE_SUBSCRIPTION_ID avec l’ID d’abonnement de l’abonnement dans lequel se trouvent vos ressources Domaine et E-mail. Exécutez l’exemple de code pour initialiser le client de gestion.

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

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

Ajouter une liste de suppression à une ressource de domaine

Pour empêcher l’envoi de vos e-mails à certaines adresses, la première étape consiste à configurer une liste de suppression dans votre ressource de domaine.

Mettez à jour l’exemple de code avec le nom du groupe de ressources, le nom du service de messagerie et le nom de ressource de domaine pour lequel vous souhaitez créer la liste de suppression. Vous trouverez ces informations sur le portail en accédant à la ressource de domaine que vous avez créée lors de la définition des prérequis. Le titre de la ressource est <your-email-service-name>/<your-domain-name>. Le nom du groupe de ressources et l’ID d’abonnement se trouvent dans les sections Informations de base de la vue d’ensemble des ressources de domaine. Choisissez également un nom pour votre ressource de liste de suppression et mettez à jour ce champ dans l’exemple.

Pour le nom de la liste, vérifiez qu’il s’agit du nom d’utilisateur de l’expéditeur de l’adresse MailFrom dont vous souhaitez supprimer les e-mails. Ces adresses MailFrom se trouvent dans la section « Adresses MailFrom » de votre ressource de domaine dans le portail. Par exemple, vous pouvez avoir une adresse MailFrom qui ressemble à « donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net ». Le nom d’utilisateur de l’expéditeur pour cette adresse serait « donotreply ». Par conséquent, vous devez utiliser le nom de liste « donotreply ».

L’exemple de code crée la liste de suppression et la stocke dans la variable suppressionListResource pour les opérations futures.

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);

Si vous souhaitez supprimer les e-mails de tous les noms d’utilisateur de l’expéditeur dans un domaine particulier, vous pouvez transmettre une chaîne vide pour le nom de la liste.

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

suppressionListResource.Update(WaitUntil.Completed, suppressionListData);

Ajouter une adresse à une liste de suppression

Après avoir configuré la liste de suppression, vous pouvez maintenant ajouter des adresses e-mail spécifiques vers lesquelles vous souhaitez empêcher l’envoi de vos messages électroniques.

Mettez à jour l’exemple de code avec l’ID d’adresse de liste de suppression. Chaque ID d’adresse de liste de suppression que vous ajoutez doit être unique. Nous vous recommandons d’utiliser un GUID. Mettez également à jour l’adresse e-mail que vous souhaitez empêcher de recevoir vos messages.

Pour ajouter plusieurs adresses à la liste de suppression, vous devez répéter cet exemple de code.

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);

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous avez choisi de supprimer. Votre e-mail ne sera pas envoyé à l’adresse supprimée.

Si vous essayez d’envoyer un e-mail à partir d’un nom d’utilisateur d’expéditeur qui n’est pas supprimé, l’e-mail sera toujours envoyé.

Supprimer une adresse d’une liste de suppression

Pour supprimer une adresse de la liste de suppression, créez SuppressionListAddressResource comme indiqué dans les exemples de code précédents et appelez la méthode Delete.

suppressionListAddressResource.Delete(WaitUntil.Completed);

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous choisissez de supprimer. Votre e-mail est envoyé à l’adresse précédemment supprimée.

Supprimer une liste de suppression d’une ressource de domaine

Pour supprimer une liste de suppression de la ressource de domaine, créez l’élément SuppressionListResource comme indiqué dans les exemples de code précédents et appelez la méthode Delete.

suppressionListResource.Delete(WaitUntil.Completed);

Prérequis

Installer les packages requis

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

Initialiser le client de gestion

Remplacez le champ dans l’exemple de code par l’ID d’abonnement de l’abonnement dans lequel se trouvent vos ressources Domaine et E-mail. Exécutez l’exemple de code pour initialiser le client de gestion.

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);

Ajouter une liste de suppression à une ressource de domaine

Pour empêcher l’envoi de vos e-mails à certaines adresses, la première étape consiste à configurer une liste de suppression dans votre ressource de domaine.

Mettez à jour l’exemple de code avec le nom du groupe de ressources, le nom du service de messagerie et le nom de ressource de domaine pour lequel vous souhaitez créer la liste de suppression. Vous trouverez ces informations sur le portail en accédant à la ressource de domaine que vous avez créée lors de la définition des prérequis. Le titre de la ressource est <your-email-service-name>/<your-domain-name>. Le nom du groupe de ressources et l’ID d’abonnement se trouvent dans les sections Informations de base de la vue d’ensemble des ressources de domaine. Choisissez également un nom pour votre ressource de liste de suppression et mettez à jour ce champ dans l’exemple.

Pour le nom de la liste, vérifiez qu’il s’agit du nom d’utilisateur de l’expéditeur de l’adresse MailFrom dont vous souhaitez supprimer les e-mails. Ces adresses MailFrom se trouvent dans la section « Adresses MailFrom » de votre ressource de domaine dans le portail. Par exemple, vous pouvez avoir une adresse MailFrom qui ressemble à « donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net ». Le nom d’utilisateur de l’expéditeur pour cette adresse serait « donotreply ». Par conséquent, vous devez utiliser le nom de liste « donotreply ».

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
);

Si vous souhaitez supprimer les e-mails de tous les noms d’utilisateur de l’expéditeur dans un domaine particulier, vous pouvez transmettre une chaîne vide pour le nom de la liste.

parameters = { 
    "listName": "",
}

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

Ajouter une adresse à une liste de suppression

Après avoir configuré la liste de suppression, vous pouvez maintenant ajouter des adresses e-mail spécifiques vers lesquelles vous souhaitez empêcher l’envoi de vos messages électroniques.

Mettez à jour l’exemple de code avec l’ID d’adresse de liste de suppression. Chaque ID d’adresse de liste de suppression que vous ajoutez doit être unique. Nous vous recommandons d’utiliser un GUID. Mettez également à jour l’adresse e-mail que vous souhaitez empêcher de recevoir vos messages.

Pour ajouter plusieurs adresses à la liste de suppression, vous devez répéter cet exemple de code.

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
);

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous avez choisi de supprimer. Votre e-mail ne sera pas envoyé à l’adresse supprimée.

Si vous essayez d’envoyer un e-mail à partir d’un nom d’utilisateur d’expéditeur qui n’est pas supprimé, l’e-mail sera toujours envoyé.

Supprimer une adresse d’une liste de suppression

Appelez la méthode delete sur suppressionListAddresses pour supprimer une adresse de la liste de suppression.

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

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous choisissez de supprimer. Votre e-mail est envoyé à l’adresse précédemment supprimée.

Supprimer une liste de suppression d’une ressource de domaine

Appelez la méthode delete sur suppressionList pour supprimer une liste de suppression de la ressource de domaine.

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

Prérequis

Installer les packages requis

Ajoutez les dépendances suivantes à votre 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>

Initialiser le client de gestion

Définissez la variable d’environnement AZURE_SUBSCRIPTION_ID avec l’ID d’abonnement de l’abonnement dans lequel se trouvent vos ressources Domaine et E-mail.

Ajoutez les importations suivantes en haut de votre fichier.

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;

Exécutez l’exemple de code pour initialiser le client de gestion.

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

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

Ajouter une liste de suppression à une ressource de domaine

Pour empêcher l’envoi de vos e-mails à certaines adresses, la première étape consiste à configurer une liste de suppression dans votre ressource de domaine.

Mettez à jour l’exemple de code avec le nom du groupe de ressources, le nom du service de messagerie et le nom de ressource de domaine pour lequel vous souhaitez créer la liste de suppression. Vous trouverez ces informations sur le portail en accédant à la ressource de domaine que vous avez créée lors de la définition des prérequis. Le titre de la ressource est <your-email-service-name>/<your-domain-name>. Le nom du groupe de ressources et l’ID d’abonnement se trouvent dans les sections Informations de base de la vue d’ensemble des ressources de domaine. Choisissez également un nom pour votre ressource de liste de suppression et mettez à jour ce champ dans l’exemple.

Pour le nom de la liste, vérifiez qu’il s’agit du nom d’utilisateur de l’expéditeur de l’adresse MailFrom dont vous souhaitez supprimer les e-mails. Ces adresses MailFrom se trouvent dans la section « Adresses MailFrom » de votre ressource de domaine dans le portail. Par exemple, vous pouvez avoir une adresse MailFrom qui ressemble à « donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net ». Le nom d’utilisateur de l’expéditeur pour cette adresse serait « donotreply ». Par conséquent, vous devez utiliser le nom de liste « donotreply ».

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();

Si vous souhaitez supprimer les e-mails de tous les noms d’utilisateur de l’expéditeur dans un domaine particulier, vous pouvez transmettre une chaîne vide pour le nom de la liste.

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

Ajouter une adresse à une liste de suppression

Après avoir configuré la liste de suppression, vous pouvez maintenant ajouter des adresses e-mail spécifiques vers lesquelles vous souhaitez empêcher l’envoi de vos messages électroniques.

Mettez à jour l’exemple de code avec l’ID d’adresse de liste de suppression. Chaque ID d’adresse de liste de suppression que vous ajoutez doit être unique. Nous vous recommandons d’utiliser un GUID. Mettez également à jour l’adresse e-mail que vous souhaitez empêcher de recevoir vos messages.

Pour ajouter plusieurs adresses à la liste de suppression, vous devez répéter cet exemple de code.

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();

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous avez choisi de supprimer. Votre e-mail ne sera pas envoyé à l’adresse supprimée.

Si vous essayez d’envoyer un e-mail à partir d’un nom d’utilisateur d’expéditeur qui n’est pas supprimé, l’e-mail sera toujours envoyé.

Supprimer une adresse d’une liste de suppression

Appelez la méthode delete sur suppressionListAddresses pour supprimer une adresse de la liste de suppression.

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

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous choisissez de supprimer. Votre e-mail est envoyé à l’adresse précédemment supprimée.

Supprimer une liste de suppression d’une ressource de domaine

Appelez la méthode delete sur suppressionLists pour supprimer une liste de suppression de la ressource de domaine.

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

Prérequis

Installer les packages requis

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

Initialiser le client de gestion

Définissez la variable d’environnement AZURE_SUBSCRIPTION_ID avec l’ID d’abonnement de l’abonnement dans lequel se trouvent vos ressources Domaine et E-mail. Exécutez l’exemple de code pour initialiser le client de gestion.

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

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

mgmt_client = CommunicationServiceManagementClient(credential, subscription_id)

Ajouter une liste de suppression à une ressource de domaine

Pour empêcher l’envoi de vos e-mails à certaines adresses, la première étape consiste à configurer une liste de suppression dans votre ressource de domaine.

Mettez à jour l’exemple de code avec le nom du groupe de ressources, le nom du service de messagerie et le nom de ressource de domaine pour lequel vous souhaitez créer la liste de suppression. Vous trouverez ces informations sur le portail en accédant à la ressource de domaine que vous avez créée lors de la définition des prérequis. Le titre de la ressource est <your-email-service-name>/<your-domain-name>. Le nom du groupe de ressources et l’ID d’abonnement se trouvent dans les sections Informations de base de la vue d’ensemble des ressources de domaine. Choisissez également un nom pour votre ressource de liste de suppression et mettez à jour ce champ dans l’exemple.

Pour le nom de la liste, vérifiez qu’il s’agit du nom d’utilisateur de l’expéditeur de l’adresse MailFrom dont vous souhaitez supprimer les e-mails. Ces adresses MailFrom se trouvent dans la section « Adresses MailFrom » de votre ressource de domaine dans le portail. Par exemple, vous pouvez avoir une adresse MailFrom qui ressemble à « donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net ». Le nom d’utilisateur de l’expéditeur pour cette adresse serait « donotreply ». Par conséquent, vous devez utiliser le nom de liste « donotreply ».

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
        }
    },
)

Si vous souhaitez supprimer les e-mails de tous les noms d’utilisateur de l’expéditeur dans un domaine particulier, vous pouvez transmettre une chaîne vide pour le nom de la liste.

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

Ajouter une adresse à une liste de suppression

Après avoir configuré la liste de suppression, vous pouvez maintenant ajouter des adresses e-mail spécifiques vers lesquelles vous souhaitez empêcher l’envoi de vos messages électroniques.

Mettez à jour l’exemple de code avec l’ID d’adresse de liste de suppression. Chaque ID d’adresse de liste de suppression que vous ajoutez doit être unique. Nous vous recommandons d’utiliser un GUID. Mettez également à jour l’adresse e-mail que vous souhaitez empêcher de recevoir vos messages.

Pour ajouter plusieurs adresses à la liste de suppression, vous devez répéter cet exemple de code.

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
        }
    },
)

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous choisissez de supprimer. Votre e-mail ne sera pas envoyé à l’adresse supprimée.

Si vous essayez d’envoyer un e-mail à partir d’un nom d’utilisateur d’expéditeur qui n’est pas supprimé, l’e-mail sera toujours envoyé.

Supprimer une adresse d’une liste de suppression

Appelez la méthode delete sur suppression_list_addresses pour supprimer une adresse de la liste de suppression.

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

Vous pouvez maintenant essayer d’envoyer un e-mail à l’adresse supprimée de la section TryEmail de votre ressource Communication Service ou à l’aide de l’un des kits SDK E-mail. Veillez à envoyer l’e-mail à l’aide de l’adresse MailFrom avec le nom d’utilisateur de l’expéditeur que vous avez choisi de supprimer. Votre e-mail est envoyé à l’adresse précédemment supprimée.

Supprimer une liste de suppression d’une ressource de domaine

Appelez la méthode delete sur suppression_lists pour supprimer une liste de suppression de la ressource de domaine.

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