Compartilhar via


Início Rápido: criar e gerenciar recursos do Serviço de Comunicação por Email

Introdução ao Email provisionando seu primeiro recurso do Serviço de Comunicação por Email. Provisione recursos do Serviço de Comunicação de Email por meio do portal do Azure ou usando a biblioteca de clientes de gerenciamento do .NET. A biblioteca de clientes de gerenciamento e o portal do Azure permitem que você crie, configure, atualize e exclua seus recursos e interface usando o serviço de implantação e gerenciamento do Azure: Azure Resource Manager. Todas as funções disponíveis nas bibliotecas de clientes estão disponíveis no portal do Azure.

Aviso

Observe que não é possível criar um grupo de recursos e um recurso ao mesmo tempo nos Serviços de Comunicação do Azure. Na criação de um recurso, é obrigatório usar um grupo de recursos já criado.

Pré-requisitos

Criar o recurso do Serviço de Comunicações por Email usando o portal

  1. Abra o portal do Azure para criar um novo recurso.

  2. Pesquise pelos Serviços de Comunicação de Email.

    Captura de tela que mostra como pesquisar o Serviço de Comunicação por Email no Marketplace.

  3. Selecione Serviços de Comunicação por Email e pressione Criar

    Captura de tela que mostra Criar link para criar o Serviço de Comunicação por Email.

  4. Insira as informações necessárias na guia Noções básicas:

    • Selecione uma assinatura existente do Azure.

    • Selecione um grupo de recursos existente ou crie um novo clicando no link Criar novo.

    • Forneça um nome válido para o recurso.

    • Selecione a região em que o recurso precisa estar disponível.

    • Selecione Estados Unidos como o local dos dados.

    • Para adicionar marcas, clique em Avançar: Marcas

    • Adicione quaisquer pares nome/valor.

      Captura de tela que mostra como analisar e criar o Serviço de Comunicação por Email.

  5. Clique em Próximo: Examinar + criar.

  6. Aguarde a validação ser aprovada e clique em Criar.

  7. Aguarde a conclusão da Implantação e clique em Ir para o Recurso para abrir a visão geral do Serviço de Comunicação de Email.

    Captura de tela que mostra a visão geral do recurso do Serviço de Comunicação por Email.

Pré-requisitos

Criar recurso de Serviços de Comunicação do Azure por email

Para criar um recurso de Serviços de Comunicação por Email, inscreva-se na CLI do Azure. Para se conectar, execute o comando az login no terminal e forneça suas credenciais. Para criar o recurso, execute o seguinte comando:

az communication email create --name "<EmailServiceName>" --location "Global" --data-location "United States" --resource-group "<resourceGroup>"

Se quiser selecionar uma assinatura específica, você também poderá especificar o sinalizador --subscription e fornecer a ID da assinatura.

az communication email create --name "<EmailServiceName>" --location "Global" --data-location "United States" --resource-group "<resourceGroup>" --subscription "<subscriptionId>"

Você pode configurar seu recurso de Serviços de Comunicação por Email com as seguintes opções:

  • O grupo de recursos
  • O nome do recurso Serviços de Comunicação por Email
  • A geografia à qual o recurso será associado

Na próxima etapa, você pode atribuir marcas ao recurso. As tags podem ser usadas para organizar seus recursos de email do Azure. Para obter mais informações sobre marcas, confira a documentação de marcação de recursos.

Gerencie seu recurso de Serviços de Comunicação do Azure por email

Para adicionar tags ao seu recurso Email Serviços de Comunicação do Azure, execute os comandos a seguir. Você também pode direcionar uma assinatura específica.

az communication email update --name "<EmailServiceName>" --tags newTag="newVal1" --resource-group "<resourceGroup>"

az communication email update --name "<EmailServiceName>" --tags newTag="newVal2" --resource-group "<resourceGroup>" --subscription "<subscriptionId>"

Para listar todos os seus recursos do serviço de comunicação por email em um determinado grupo de recursos, use o seguinte comando:

az communication email list --resource-group "<resourceGroup>"

Para mostrar todas as informações sobre um determinado recurso do Email Communication Service, use o seguinte comando. Você também pode direcionar uma assinatura específica.

az communication email show --name "<EmailServiceName>" --resource-group "<resourceGroup>"

az communication email show --name "<EmailServiceName>" --resource-group "<resourceGroup>" --subscription "<subscriptionId>"

Limpar recurso

Se quiser limpar e remover uma assinatura dos Serviços de Comunicação por Email, você poderá excluir o recurso ou grupo de recursos. Você pode excluir seu recurso de comunicação por email executando o comando a seguir.

az communication email delete --name "<EmailServiceName>" --resource-group "<resourceGroup>"

Excluir o grupo de recursos também exclui todos os recursos associados a ele.

Observação

A exclusão de recursos é permanente e nenhum dado, incluindo filtros de grade de eventos, números de telefone ou outros dados vinculados ao recurso, poderá ser recuperado se você excluir o recurso.

Para obter informações sobre outros comandos, veja CLI de comunicação por email.

Pré-requisitos

Instalando o SDK

Primeiro, inclua o SDK de Gerenciamento dos Serviços de Comunicação no seu projeto C#:

using Azure.ResourceManager.Communication;

ID da assinatura

Você precisará saber a ID da sua assinatura do Azure. Isso pode ser adquirido no portal:

  1. Fazer logon na sua conta do Azure
  2. Selecione Assinaturas na barra lateral à esquerda
  3. Selecione qualquer assinatura necessária
  4. Clique em Visão Geral
  5. Selecione a sua ID de Assinatura

Neste guia de início rápido, vamos pressupor que você armazenou a ID da assinatura em uma variável de ambiente chamada AZURE_SUBSCRIPTION_ID.

Autenticação

Para se comunicar com os Serviços de Comunicação do Azure, primeiro você precisa se autenticar no Azure.

Autenticar o Cliente

A opção padrão para criar um cliente autenticado é usar DefaultAzureCredential. Como todas as APIs de gerenciamento passam pelo mesmo ponto de extremidade, para interagir com os recursos, apenas um ArmClient de nível superior deve ser criado.

Para autenticar no Azure e criar um ArmClient, faça o seguinte código:

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Communication;
using Azure.ResourceManager.Resources;
...
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

Interação com os recursos do Azure

Agora que você está autenticado.

Para cada um dos exemplos a seguir, atribuiremos nossos recursos de serviços de email a um grupo de recursos existente.

Se precisar criar um grupo de recursos, você poderá fazer isso usando o portal do Azure ou o SDK do Azure Resource Manager.

Crie um recurso de serviços de email

Ao criar um recurso de Serviços de Email, você especificará o nome do grupo de recursos e o nome do recurso.

Observação

A propriedade Location é sempre global e, durante a visualização pública, o valor de DataLocation deve ser UnitedStates.

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this EmailServiceResource
EmailServiceResourceCollection collection = resourceGroupResource.GetEmailServiceResources();

// invoke the operation
string emailServiceName = "MyEmailServiceResource";
EmailServiceResourceData data = new EmailServiceResourceData(new AzureLocation("Global"))
{
    DataLocation = "United States",
};
ArmOperation<EmailServiceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, emailServiceName, data);
EmailServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EmailServiceResourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

Gerencie seu recurso de Serviços de Comunicação do Azure por email

Atualizar um recurso dos Serviços de Comunicação por Email

...
// this example assumes you already have this EmailServiceResource created on azure
// for more information of creating EmailServiceResource, please refer to the document of EmailServiceResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
string emailServiceName = "MyEmailServiceResource";
ResourceIdentifier emailServiceResourceId = EmailServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, emailServiceName);
EmailServiceResource emailServiceResource = client.GetEmailServiceResource(emailServiceResourceId);

// invoke the operation
EmailServiceResourcePatch patch = new EmailServiceResourcePatch()
{
    Tags =
    {
    ["newTag"] = "newVal",
    },
};
ArmOperation<EmailServiceResource> lro = await emailServiceResource.UpdateAsync(WaitUntil.Completed, patch);
EmailServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EmailServiceResourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

Listar todos os recursos do Serviço de Comunicação por Email por grupo de recursos

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this EmailServiceResource
EmailServiceResourceCollection collection = resourceGroupResource.GetEmailServiceResources();

// invoke the operation and iterate over the result
await foreach (EmailServiceResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EmailServiceResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

Listar todos os recursos do Serviço de comunicação por email por assinatura

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (EmailServiceResource item in subscriptionResource.GetEmailServiceResourcesAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EmailServiceResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

Limpar recurso

// this example assumes you already have this EmailServiceResource created on azure
// for more information of creating EmailServiceResource, please refer to the document of EmailServiceResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
string emailServiceName = "MyEmailServiceResource";
ResourceIdentifier emailServiceResourceId = EmailServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, emailServiceName);
EmailServiceResource emailServiceResource = client.GetEmailServiceResource(emailServiceResourceId);

// invoke the operation
await emailServiceResource.DeleteAsync(WaitUntil.Completed);

Console.WriteLine($"Succeeded");

Observação

A exclusão de recursos é permanente e nenhum dado, incluindo filtros de grade de eventos, números de telefone ou outros dados vinculados ao recurso, poderá ser recuperado se você excluir o recurso.

Pré-requisitos

Criar recurso de serviço de comunicação por email

Para criar um recurso de serviço de comunicação por email, entre em sua conta do Azure usando Connect-AzAccount usando o comando a seguir e forneça suas credenciais.

PS C:\> Connect-AzAccount

Primeiro, instale o módulo Az.Communication dos Serviços de Comunicação do Azure usando o comando a seguir.

PS C:\> Install-Module Az.Communication

Para criar o recurso, execute o seguinte comando:

PS C:\> New-AzEmailService -ResourceGroupName ContosoResourceProvider1 -Name ContosoEmailServiceResource1 -DataLocation UnitedStates

Se quiser selecionar uma assinatura específica, você também poderá especificar o sinalizador --subscription e fornecer a ID da assinatura.

PS C:\> New-AzEmailService -ResourceGroupName ContosoResourceProvider1 -Name ContosoEmailServiceResource1 -DataLocation UnitedStates -SubscriptionId SubscriptionID

Configure o recurso dos Serviços de Comunicação com as seguintes opções:

  • O grupo de recursos
  • O nome do recurso Serviços de Comunicação por Email
  • A geografia à qual o recurso será associado

Na próxima etapa, você pode atribuir marcas ao recurso. As tags podem ser usadas para organizar seus recursos de email do Azure. Para obter mais informações sobre marcas, confira a documentação de marcação de recursos.

Gerencie seu recurso de Serviços de Comunicação do Azure por email

Para adicionar tags ao seu recurso Email Serviços de Comunicação do Azure, execute os comandos a seguir. Você também pode direcionar uma assinatura específica.

PS C:\> Update-AzEmailService -Name ContosoEmailServiceResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="ExampleValue1"}

PS C:\> Update-AzEmailService -Name ContosoEmailServiceResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="ExampleValue1"} -SubscriptionId SubscriptionID

Para listar todos os seus recursos do Email Communication Service em uma determinada assinatura, use o seguinte comando:

PS C:\> Get-AzEmailService -SubscriptionId SubscriptionID

Para listar todas as informações sobre um determinado recurso, use o seguinte comando:

PS C:\> Get-AzEmailService -Name ContosoEmailServiceResource1 -ResourceGroupName ContosoResourceProvider1

Limpar recurso

Se quiser limpar e remover um Serviços de Comunicação do Azure por email, você pode excluir seu recurso de comunicação por email executando o seguinte comando:

PS C:\> Remove-AzEmailService -Name ContosoEmailServiceResource1 -ResourceGroupName ContosoResourceProvider1

Observação

A exclusão de recursos é permanente e nenhum dado, incluindo filtros de grade de eventos, números de telefone ou outros dados vinculados ao recurso, poderá ser recuperado se você excluir o recurso.

Próximas etapas