Compartir a través de

Administrar listas de supresión de dominio con SDK de administración

Importante

Esta característica de Azure Communication Services se encuentra actualmente en versión preliminar. Las características de la versión preliminar están disponibles públicamente y se pueden usar en todos los clientes nuevos y existentes de Microsoft.

Esta versión preliminar se ofrece sin un Acuerdo de Nivel de Servicio y no se recomienda para cargas de trabajo de producción. Es posible que algunas características no sean compatibles o que las funcionalidades estén restringidas.

Para más información, consulte Términos de uso complementarios para las versiones preliminares de Microsoft Azure.

En este artículo se describe cómo administrar listas de supresión de dominio en Azure Communication Services mediante las bibliotecas cliente de administración de Azure Communication Services.

Requisitos previos

Instalación de los paquetes necesarios

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

Inicializar el cliente de administración

Establecer la variable de entorno AZURE_SUBSCRIPTION_ID con el id. de suscripción de la suscripción en la que se encuentran los recursos de dominio y correo electrónico. Ejecutar el ejemplo de código para inicializar el cliente de administración.

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

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

Adición de una lista de supresión a un recurso de dominio

Para impedir que los mensajes de correo electrónico se envíen a determinadas direcciones, el primer paso consiste en configurar una lista de supresión en el recurso de dominio.

Actualice el ejemplo de código con el nombre del grupo de recursos, el nombre del servicio de correo electrónico y el nombre del recurso de dominio para el que desea crear la lista de supresión. Para encontrar esta información en el portal, vaya al recurso de dominio que creó al configurar los requisitos previos. El título del recurso es <your-email-service-name>/<your-domain-name>. Busque el nombre del grupo de recursos y el identificador de suscripción en las secciones Essentials en la información general sobre los recursos de dominio. Elija cualquier nombre para el recurso de lista de supresión y actualice ese campo también en el ejemplo.

Para el nombre de la lista, asegúrese de que es el mismo que el nombre de usuario del remitente de la dirección MailFrom de la que desea suprimir los correos electrónicos. Estas direcciones MailFrom se pueden encontrar en la sección "MailFrom addresses" del recurso de dominio en el portal. Por ejemplo, puede tener una dirección MailFrom que se vea como donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net. El nombre de usuario del remitente para esta dirección es donotreply así que use un nombre de lista de donotreply.

El ejemplo de código crea la lista de supresión y la almacena en la suppressionListResource variable para futuras operaciones.

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 desea bloquear los correos electrónicos de todos los nombres de usuario del remitente de un dominio específico, puede pasar una cadena vacía como nombre de lista.

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

suppressionListResource.Update(WaitUntil.Completed, suppressionListData);

Agregar una dirección a una lista de supresión

Después de configurar la lista de supresión, ahora puede agregar direcciones de correo electrónico específicas a las que desea impedir que se envíen los mensajes de correo electrónico.

Actualice el ejemplo de código con el identificador de dirección de la lista de supresión. Cada identificador de dirección de lista de supresión que agregue debe ser único. Se recomienda usar un GUID. Actualice también la dirección de correo electrónico que desea impedir que reciba los mensajes.

Para agregar varias direcciones a la lista de supresión, debe repetir este ejemplo de código varias veces.

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

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que ha suprimido. Tu correo electrónico no se envía a la dirección bloqueada.

Si intenta enviar un correo electrónico desde un nombre de usuario de remitente que no está suprimido, este aun así se envía correctamente.

Quitar una dirección de una lista de supresión

Para quitar una dirección de la lista de supresión, cree el SuppressionListAddressResource como se muestra en los ejemplos de código anteriores y llame al método Delete.

suppressionListAddressResource.Delete(WaitUntil.Completed);

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que elija suprimir. El correo electrónico se envía de manera correcta a la dirección suprimida anteriormente.

Eliminación de una lista de supresión de un recurso de dominio

Para quitar una lista de supresión del recurso de dominio, cree el SuppressionListResource como se muestra en los ejemplos de código anteriores y llame al método Delete.

suppressionListResource.Delete(WaitUntil.Completed);

Requisitos previos

Instalación de los paquetes necesarios

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

Inicializar el cliente de administración

Reemplace el campo del código de ejemplo por el id. de suscripción de la suscripción en la que se encuentran los recursos de dominio y correo electrónico. Ejecutar el ejemplo de código para inicializar el cliente de administración.

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

Adición de una lista de supresión a un recurso de dominio

Para impedir que los mensajes de correo electrónico se envíen a determinadas direcciones, el primer paso consiste en configurar una lista de supresión en el recurso de dominio.

Actualice el ejemplo de código con el nombre del grupo de recursos, el nombre del servicio de correo electrónico y el nombre del recurso de dominio para el que desea crear la lista de supresión. Para encontrar esta información en el portal, vaya al recurso de dominio que creó al configurar los requisitos previos. El título del recurso es <your-email-service-name>/<your-domain-name>. Busque el nombre del grupo de recursos y el identificador de suscripción en las secciones Essentials en la información general sobre los recursos de dominio. Elija cualquier nombre para el recurso de lista de supresión y actualice ese campo también en el ejemplo.

Para el nombre de la lista, asegúrese de que es el mismo que el nombre de usuario del remitente de la dirección MailFrom de la que desea suprimir los correos electrónicos. Estas direcciones MailFrom se pueden encontrar en la sección "MailFrom addresses" del recurso de dominio en el portal. Por ejemplo, puede tener una dirección MailFrom que se vea como donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net. El nombre de usuario del remitente para esta dirección es donotreply así que use un nombre de lista de 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 desea bloquear los correos electrónicos de todos los nombres de usuario del remitente de un dominio específico, puede pasar una cadena vacía como nombre de lista.

parameters = { 
    "listName": "",
}

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

Agregar una dirección a una lista de supresión

Después de configurar la lista de supresión, ahora puede agregar direcciones de correo electrónico específicas a las que desea impedir que se envíen los mensajes de correo electrónico.

Actualice el ejemplo de código con el identificador de dirección de la lista de supresión. Cada identificador de dirección de lista de supresión que agregue debe ser único. Se recomienda usar un GUID. Actualice también la dirección de correo electrónico que desea impedir que reciba los mensajes.

Para agregar varias direcciones a la lista de supresión, debe repetir este ejemplo de código varias veces.

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

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que ha suprimido. Tu correo electrónico no se envía a la dirección bloqueada.

Si intenta enviar un correo electrónico desde un nombre de usuario de remitente que no está suprimido, este aun así se envía correctamente.

Quitar una dirección de una lista de supresión

Llame al método delete en suppressionListAddresses para quitar una dirección de la lista de supresión.

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

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que ha suprimido. El correo electrónico se envía de manera correcta a la dirección suprimida anteriormente.

Eliminación de una lista de supresión de un recurso de dominio

Llame al método delete en suppressionList para quitar una lista de supresión del recurso de dominio.

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

Requisitos previos

Instalación de los paquetes necesarios

Agregue las siguientes dependencias al 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>

Inicializar el cliente de administración

Establecer la variable de entorno AZURE_SUBSCRIPTION_ID con el id. de suscripción de la suscripción en la que se encuentran los recursos de dominio y correo electrónico.

Agregue las siguientes importaciones en la parte superior del archivo.

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;

Ejecutar el ejemplo de código para inicializar el cliente de administración.

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

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

Adición de una lista de supresión a un recurso de dominio

Para impedir que los mensajes de correo electrónico se envíen a determinadas direcciones, el primer paso consiste en configurar una lista de supresión en el recurso de dominio.

Actualice el ejemplo de código con el nombre del grupo de recursos, el nombre del servicio de correo electrónico y el nombre del recurso de dominio para el que desea crear la lista de supresión. Para encontrar esta información en el portal, vaya al recurso de dominio que creó al configurar los requisitos previos. El título del recurso es <your-email-service-name>/<your-domain-name>. Busque el nombre del grupo de recursos y el identificador de suscripción en las secciones Essentials en la información general sobre los recursos de dominio. Elija cualquier nombre para el recurso de lista de supresión y actualice ese campo también en el ejemplo.

Para el nombre de la lista, asegúrese de que es el mismo que el nombre de usuario del remitente de la dirección MailFrom de la que desea suprimir los correos electrónicos. Estas direcciones MailFrom se pueden encontrar en la sección "MailFrom addresses" del recurso de dominio en el portal. Por ejemplo, puede tener una dirección MailFrom que se vea como donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net. El nombre de usuario del remitente para esta dirección es donotreply así que use un nombre de lista de 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 desea suprimir los correos electrónicos de todos los nombres de usuario del remitente en un dominio particular, puede ingresar una cadena vacía como nombre de la lista.

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

Agregar una dirección a una lista de supresión

Después de configurar la lista de supresión, ahora puede agregar direcciones de correo electrónico específicas a las que desea impedir que se envíen los mensajes de correo electrónico.

Actualice el ejemplo de código con el identificador de dirección de la lista de supresión. Cada identificador de dirección de lista de supresión que agregue debe ser único. Se recomienda usar un GUID. Actualice también la dirección de correo electrónico que desea impedir que reciba los mensajes.

Para agregar varias direcciones a la lista de supresión, debe repetir este ejemplo de código varias veces.

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

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que ha suprimido. Tu correo electrónico no se envía a la dirección bloqueada.

Si intenta enviar un correo electrónico desde un nombre de usuario de remitente que no está suprimido, este aun así se envía correctamente.

Quitar una dirección de una lista de supresión

Llame al método delete en suppressionListAddresses para quitar una dirección de la lista de supresión.

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

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que elija suprimir. El correo electrónico se envía de manera correcta a la dirección suprimida anteriormente.

Eliminación de una lista de supresión de un recurso de dominio

Llame al método delete en suppressionLists para quitar una lista de supresión del recurso de dominio.

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

Requisitos previos

Instalación de los paquetes necesarios

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

Inicializar el cliente de administración

Establecer la variable de entorno AZURE_SUBSCRIPTION_ID con el id. de suscripción de la suscripción en la que se encuentran los recursos de dominio y correo electrónico. Ejecutar el ejemplo de código para inicializar el cliente de administración.

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

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

mgmt_client = CommunicationServiceManagementClient(credential, subscription_id)

Adición de una lista de supresión a un recurso de dominio

Para impedir que los mensajes de correo electrónico se envíen a determinadas direcciones, el primer paso consiste en configurar una lista de supresión en el recurso de dominio.

Actualice el ejemplo de código con el nombre del grupo de recursos, el nombre del servicio de correo electrónico y el nombre del recurso de dominio para el que desea crear la lista de supresión. Para encontrar esta información en el portal, vaya al recurso de dominio que creó al configurar los requisitos previos. El título del recurso es <your-email-service-name>/<your-domain-name>. Busque el nombre del grupo de recursos y el identificador de suscripción en las secciones Essentials en la información general sobre los recursos de dominio. Elija cualquier nombre para el recurso de lista de supresión y actualice ese campo también en el ejemplo.

Para el nombre de la lista, asegúrese de que es el mismo que el nombre de usuario del remitente de la dirección MailFrom de la que desea suprimir los correos electrónicos. Estas direcciones MailFrom se pueden encontrar en la sección "MailFrom addresses" del recurso de dominio en el portal. Por ejemplo, puede tener una dirección MailFrom que se vea como donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net. El nombre de usuario del remitente para esta dirección es donotreply así que use un nombre de lista de 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 desea suprimir los correos electrónicos de todos los nombres de usuario del remitente en un dominio particular, puede ingresar una cadena vacía como nombre de la lista.

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

Agregar una dirección a una lista de supresión

Después de configurar la lista de supresión, ahora puede agregar direcciones de correo electrónico específicas a las que desea impedir que se envíen los mensajes de correo electrónico.

Actualice el ejemplo de código con el identificador de dirección de la lista de supresión. Cada identificador de dirección de lista de supresión que agregue debe ser único. Se recomienda usar un GUID. Actualice también la dirección de correo electrónico que desea impedir que reciba los mensajes.

Para agregar varias direcciones a la lista de supresión, debe repetir este ejemplo de código varias veces.

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

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que ha suprimido. Tu correo electrónico no se envía a la dirección bloqueada.

Si intenta enviar un correo electrónico desde un nombre de usuario de remitente que no está suprimido, este aun así se envía correctamente.

Quitar una dirección de una lista de supresión

Llame al método delete en suppression_list_addresses para quitar una dirección de la lista de supresión.

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

Ahora puede intentar enviar un correo electrónico a la dirección suprimida de la TryEmail sección del recurso de Communication Service o mediante uno de los SDK de correo electrónico. Asegúrese de enviar el correo electrónico mediante la dirección MailFrom con el nombre de usuario del remitente que ha suprimido. El correo electrónico se envía de manera correcta a la dirección suprimida anteriormente.

Eliminación de una lista de supresión de un recurso de dominio

Llame al método delete en suppression_lists para quitar una lista de supresión del recurso de dominio.

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