Поделиться через


Краткое руководство. Управление списками подавления домена в Службы коммуникации Azure с помощью клиентских библиотек управления

Внимание

Функции, описанные в этой статье, в настоящее время находятся в общедоступной предварительной версии. Эта предварительная версия предоставляется без соглашения об уровне обслуживания. Ее не следует использовать для производственных рабочих нагрузок. Некоторые функции могут не поддерживаться или их возможности могут быть ограничены. Дополнительные сведения см. в статье Дополнительные условия использования Предварительных версий Microsoft Azure.

В этом кратком руководстве рассматривается процесс управления списками подавления домена в Службы коммуникации Azure с помощью клиентских библиотек управления Службы коммуникации Azure.

Необходимые компоненты

Установка необходимых пакетов

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

Инициализация клиента управления

Задайте переменную AZURE_SUBSCRIPTION_ID среды с идентификатором подписки, в которой находятся ресурсы домена и электронной почты. Запустите пример кода, чтобы инициализировать клиент управления.

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

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

Добавление списка подавления в ресурс домена

Чтобы заблокировать отправку сообщений электронной почты на определенные адреса, первым шагом является настройка списка подавления в ресурсе домена.

Обновите пример кода с именем группы ресурсов, именем службы электронной почты и доменным именем ресурса, для которого вы хотите создать список подавления. Найдите эти сведения на портале, перейдя к ресурсу домена, созданному при настройке необходимых компонентов. Заголовок ресурса .<your-email-service-name>/<your-domain-name> Найдите имя группы ресурсов и идентификатор подписки в разделах Essentials в обзоре ресурса домена. Выберите любое имя ресурса списка подавления и обновите это поле в примере.

Для имени списка убедитесь, что имя отправителя совпадает с именем отправителя адреса MailFrom, из который вы хотите отключить сообщения электронной почты. Эти адреса MailFrom можно найти в разделе "Адреса MailFrom" ресурса домена на портале. Например, у вас может быть адрес MailFrom, который выглядит как "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Имя отправителя для этого адреса будет "donotreply", поэтому следует использовать имя списка "donotreply".

Пример кода создаст список подавления и сохранит его в переменной suppressionListResource для будущих операций.

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

Если вы хотите отключить сообщения электронной почты от всех имен пользователей отправителя в определенном домене, можно передать пустую строку для имени списка.

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

suppressionListResource.Update(WaitUntil.Completed, suppressionListData);

Добавление адреса в список подавления

После настройки списка подавления теперь можно добавить определенные адреса электронной почты, в которые вы хотите предотвратить отправку сообщений электронной почты.

Обновите пример кода с идентификатором адреса списка подавления. Каждый идентификатор адреса списка подавления, который необходимо добавить, должен быть уникальным. Рекомендуется использовать GUID. Обновите адрес электронной почты, который вы хотите заблокировать от получения сообщений.

Чтобы добавить несколько адресов в список подавления, необходимо повторить этот пример кода несколько раз.

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

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы выбрали для подавления. Сообщение электронной почты не отправляется на отложенный адрес.

Если вы попытаетесь отправить сообщение электронной почты от имени пользователя отправителя, которое не подавляется, сообщение по-прежнему отправляется успешно.

Удаление адреса из списка подавления

Чтобы удалить адрес из списка подавления, создайте его SuppressionListAddressResource , как показано в предыдущих примерах кода, и вызовите Delete метод.

suppressionListAddressResource.Delete(WaitUntil.Completed);

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы решили отключить. Ваше сообщение будет успешно отправлено на ранее отложенный адрес.

Удаление списка подавления из ресурса домена

Чтобы удалить список подавления из ресурса домена, создайте, SuppressionListResource как показано в предыдущих примерах кода, и вызовите Delete метод.

suppressionListResource.Delete(WaitUntil.Completed);

Необходимые компоненты

Установка необходимых пакетов

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

Инициализация клиента управления

Замените поле в примере кода идентификатором подписки подписки, в которых находятся ресурсы домена и электронной почты. Запустите пример кода, чтобы инициализировать клиент управления.

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

Добавление списка подавления в ресурс домена

Чтобы заблокировать отправку сообщений электронной почты на определенные адреса, первым шагом является настройка списка подавления в ресурсе домена.

Обновите пример кода с именем группы ресурсов, именем службы электронной почты и доменным именем ресурса, для которого вы хотите создать список подавления. Найдите эти сведения на портале, перейдя к ресурсу домена, созданному при настройке необходимых компонентов. Заголовок ресурса .<your-email-service-name>/<your-domain-name> Найдите имя группы ресурсов и идентификатор подписки в разделах Essentials в обзоре ресурса домена. Выберите любое имя ресурса списка подавления и обновите это поле в примере.

Для имени списка убедитесь, что имя отправителя совпадает с именем отправителя адреса MailFrom, из который вы хотите отключить сообщения электронной почты. Эти адреса MailFrom можно найти в разделе "Адреса MailFrom" ресурса домена на портале. Например, у вас может быть адрес MailFrom, который выглядит как "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Имя отправителя для этого адреса будет "donotreply", поэтому следует использовать имя списка "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
);

Если вы хотите отключить сообщения электронной почты от всех имен пользователей отправителя в определенном домене, можно передать пустую строку для имени списка.

parameters = { 
    "listName": "",
}

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

Добавление адреса в список подавления

После настройки списка подавления теперь можно добавить определенные адреса электронной почты, в которые вы хотите предотвратить отправку сообщений электронной почты.

Обновите пример кода с идентификатором адреса списка подавления. Каждый идентификатор адреса списка подавления, который необходимо добавить, должен быть уникальным. Рекомендуется использовать GUID. Обновите адрес электронной почты, который вы хотите заблокировать от получения сообщений.

Чтобы добавить несколько адресов в список подавления, необходимо повторить этот пример кода несколько раз.

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

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы выбрали для подавления. Сообщение электронной почты не отправляется на отложенный адрес.

Если вы попытаетесь отправить сообщение электронной почты от имени пользователя отправителя, которое не подавляется, сообщение по-прежнему отправляется успешно.

Удаление адреса из списка подавления

delete Вызовите методsuppressionListAddresses, чтобы удалить адрес из списка подавления.

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

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы решили отключить. Ваше сообщение будет успешно отправлено на ранее отложенный адрес.

Удаление списка подавления из ресурса домена

delete Вызовите методsuppressionList, чтобы удалить список подавления из ресурса домена.

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

Необходимые компоненты

Установка необходимых пакетов

Добавьте следующие зависимости в вашу 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>

Инициализация клиента управления

Задайте переменную AZURE_SUBSCRIPTION_ID среды с идентификатором подписки, в которой находятся ресурсы домена и электронной почты.

Добавьте следующие импорты в верхней части файла.

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;

Запустите пример кода, чтобы инициализировать клиент управления.

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

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

Добавление списка подавления в ресурс домена

Чтобы заблокировать отправку сообщений электронной почты на определенные адреса, первым шагом является настройка списка подавления в ресурсе домена.

Обновите пример кода с именем группы ресурсов, именем службы электронной почты и доменным именем ресурса, для которого вы хотите создать список подавления. Найдите эти сведения на портале, перейдя к ресурсу домена, созданному при настройке необходимых компонентов. Заголовок ресурса .<your-email-service-name>/<your-domain-name> Найдите имя группы ресурсов и идентификатор подписки в разделах Essentials в обзоре ресурса домена. Выберите любое имя ресурса списка подавления и обновите это поле в примере.

Для имени списка убедитесь, что имя отправителя совпадает с именем отправителя адреса MailFrom, из который вы хотите отключить сообщения электронной почты. Эти адреса MailFrom можно найти в разделе "Адреса MailFrom" ресурса домена на портале. Например, у вас может быть адрес MailFrom, который выглядит как "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Имя отправителя для этого адреса будет "donotreply", поэтому следует использовать имя списка "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();

Если вы хотите отключить сообщения электронной почты от всех имен пользователей отправителя в определенном домене, можно передать пустую строку для имени списка.

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

Добавление адреса в список подавления

После настройки списка подавления теперь можно добавить определенные адреса электронной почты, в которые вы хотите предотвратить отправку сообщений электронной почты.

Обновите пример кода с идентификатором адреса списка подавления. Каждый идентификатор адреса списка подавления, который необходимо добавить, должен быть уникальным. Рекомендуется использовать GUID. Обновите адрес электронной почты, который вы хотите заблокировать от получения сообщений.

Чтобы добавить несколько адресов в список подавления, необходимо повторить этот пример кода несколько раз.

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

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы выбрали для подавления. Сообщение электронной почты не отправляется на отложенный адрес.

Если вы попытаетесь отправить сообщение электронной почты от имени пользователя отправителя, которое не подавляется, сообщение по-прежнему отправляется успешно.

Удаление адреса из списка подавления

delete Вызовите методsuppressionListAddresses, чтобы удалить адрес из списка подавления.

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

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы решили отключить. Ваше сообщение будет успешно отправлено на ранее отложенный адрес.

Удаление списка подавления из ресурса домена

delete Вызовите методsuppressionLists, чтобы удалить список подавления из ресурса домена.

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

Необходимые компоненты

Установка необходимых пакетов

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

Инициализация клиента управления

Задайте переменную AZURE_SUBSCRIPTION_ID среды с идентификатором подписки, в которой находятся ресурсы домена и электронной почты. Запустите пример кода, чтобы инициализировать клиент управления.

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

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

mgmt_client = CommunicationServiceManagementClient(credential, subscription_id)

Добавление списка подавления в ресурс домена

Чтобы заблокировать отправку сообщений электронной почты на определенные адреса, первым шагом является настройка списка подавления в ресурсе домена.

Обновите пример кода с именем группы ресурсов, именем службы электронной почты и доменным именем ресурса, для которого вы хотите создать список подавления. Найдите эти сведения на портале, перейдя к ресурсу домена, созданному при настройке необходимых компонентов. Заголовок ресурса .<your-email-service-name>/<your-domain-name> Найдите имя группы ресурсов и идентификатор подписки в разделах Essentials в обзоре ресурса домена. Выберите любое имя ресурса списка подавления и обновите это поле в примере.

Для имени списка убедитесь, что имя отправителя совпадает с именем отправителя адреса MailFrom, из который вы хотите отключить сообщения электронной почты. Эти адреса MailFrom можно найти в разделе "Адреса MailFrom" ресурса домена на портале. Например, у вас может быть адрес MailFrom, который выглядит как "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net". Имя отправителя для этого адреса будет "donotreply", поэтому следует использовать имя списка "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
        }
    },
)

Если вы хотите отключить сообщения электронной почты от всех имен пользователей отправителя в определенном домене, можно передать пустую строку для имени списка.

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

Добавление адреса в список подавления

После настройки списка подавления теперь можно добавить определенные адреса электронной почты, в которые вы хотите предотвратить отправку сообщений электронной почты.

Обновите пример кода с идентификатором адреса списка подавления. Каждый идентификатор адреса списка подавления, который необходимо добавить, должен быть уникальным. Рекомендуется использовать GUID. Обновите адрес электронной почты, который вы хотите заблокировать от получения сообщений.

Чтобы добавить несколько адресов в список подавления, необходимо повторить этот пример кода несколько раз.

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

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы решили отключить. Сообщение электронной почты не отправляется на отложенный адрес.

Если вы попытаетесь отправить сообщение электронной почты от имени пользователя отправителя, которое не подавляется, сообщение по-прежнему отправляется успешно.

Удаление адреса из списка подавления

delete Вызовите методsuppression_list_addresses, чтобы удалить адрес из списка подавления.

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

Теперь вы можете попытаться отправить сообщение электронной почты в отложенный адрес из TryEmail раздела ресурса службы коммуникации или с помощью одного из пакетов SDK для электронной почты. Не забудьте отправить сообщение электронной почты с помощью адреса MailFrom с именем отправителя, которое вы выбрали для подавления. Ваше сообщение будет успешно отправлено на ранее отложенный адрес.

Удаление списка подавления из ресурса домена

delete Вызовите методsuppression_lists, чтобы удалить список подавления из ресурса домена.

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