Guia de início rápido: criar e gerenciar recursos dos Serviços de Comunicação
Comece a usar os Serviços de Comunicação do Azure provisionando seu primeiro recurso de Serviços de Comunicação. Os recursos dos Serviços de Comunicação podem ser provisionados por meio do portal do Azure ou usando o SDK de gerenciamento do .NET. O SDK de gerenciamento e o portal do Azure permitem que você crie, configure, atualize e exclua seus recursos e interface usando o novo serviço de implantação e gerenciamento: Azure Resource Manager. Todas as funções disponíveis nos SDKs estão disponíveis no portal do Azure.
Aviso
Observe que não é possível criar um grupo de recursos ao mesmo tempo que um recurso para os Serviços de Comunicação do Azure. Antes de criar um recurso, você precisa primeiro criar um grupo de recursos.
Pré-requisitos
- Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
Se você estiver planejando usar números de telefone, não poderá usar a conta de avaliação gratuita. Verifique se a sua subscrição cumpre todos os requisitos se planeia comprar números de telefone antes de criar o seu recurso.
Criar o recurso do Azure Communication Services
Para criar um recurso dos Serviços de Comunicação do Azure, primeiro entre no portal do Azure. No canto superior esquerdo da página, selecione + Criar um recurso.
Insira Comunicação na entrada Pesquisar no Marketplace ou na barra de pesquisa na parte superior do portal.
Selecione Serviços de Comunicação nos resultados e, em seguida, selecione Criar.
Agora você pode configurar seu recurso de Serviços de Comunicação. Na primeira página do processo de criação, você precisa especificar:
- A subscrição
- O grupo de recursos (você pode criar um novo ou escolher um grupo de recursos existente)
- O nome do recurso Serviços de Comunicação
- A geografia associada ao recurso
Na próxima etapa, você pode atribuir tags ao recurso. Você pode usar tags para organizar seus recursos do Azure. Para obter mais informações sobre tags, consulte Usar tags para organizar seus recursos do Azure e hierarquia de gerenciamento.
Finalmente, você pode revisar sua configuração e Criar o recurso. A implantação leva alguns minutos para ser concluída.
Gerenciar seu recurso de Serviços de Comunicação
Para gerir o seu recurso dos Serviços de Comunicação, inicie sessão no portal do Azure e procure e selecione Serviços de Comunicação do Azure.
Na página Serviços de Comunicação, selecione o nome do seu recurso.
A página Visão geral do recurso contém opções para gerenciamento básico, como procurar, parar, iniciar, reiniciar e excluir. Para obter mais opções de configuração, consulte o menu esquerdo da página de recursos.
Pré-requisitos
- Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
- Instalar a CLI do Azure
Se você estiver planejando usar números de telefone, não poderá usar a conta de avaliação gratuita. Verifique se a sua subscrição cumpre todos os requisitos se planeia comprar números de telefone antes de criar o seu recurso.
Criar o recurso do Azure Communication Services
Para criar um recurso dos Serviços de Comunicação do Azure, entre na CLI do Azure. Você pode entrar executando o az login
comando a partir do terminal e fornecer suas credenciais. Execute o seguinte comando para criar o recurso:
az communication create --name "<acsResourceName>" --location "Global" --data-location "United States" --resource-group "<resourceGroup>"
Se você quiser selecionar uma assinatura específica, você também pode especificar o --subscription
sinalizador e fornecer o ID da assinatura.
az communication create --name "<acsResourceName>" --location "Global" --data-location "United States" --resource-group "<resourceGroup>" --subscription "<subscriptionId>"
Você pode configurar seu recurso de Serviços de Comunicação com as seguintes opções:
- O grupo de recursos
- O nome do recurso Serviços de Comunicação
- A geografia associada ao recurso
Na próxima etapa, você pode atribuir tags ao recurso. Você pode usar tags para organizar seus recursos do Azure. Para obter mais informações sobre tags, consulte Usar tags para organizar seus recursos do Azure e hierarquia de gerenciamento.
Gerenciar seu recurso de Serviços de Comunicação
Para adicionar marcas ao recurso dos Serviços de Comunicação, execute os seguintes comandos. Você também pode segmentar uma assinatura específica.
az communication update --name "<communicationName>" --tags newTag="newVal1" --resource-group "<resourceGroup>"
az communication update --name "<communicationName>" --tags newTag="newVal2" --resource-group "<resourceGroup>" --subscription "<subscriptionId>"
az communication show --name "<communicationName>" --resource-group "<resourceGroup>"
az communication show --name "<communicationName>" --resource-group "<resourceGroup>" --subscription "<subscriptionId>"
Para obter informações sobre outros comandos, consulte CLI de Comunicação do Azure.
Pré-requisitos
- Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
- A versão mais recente do SDK do .NET Core para seu sistema operacional.
- Obtenha a versão mais recente do .NET Identity SDK.
- Obtenha a versão mais recente do SDK de Gerenciamento do .NET.
Se você estiver planejando usar números de telefone, não poderá usar a conta de avaliação gratuita. Verifique se a sua subscrição cumpre todos os requisitos se planeia comprar números de telefone antes de criar o seu recurso.
Instalando o SDK
Primeiro, inclua o SDK de Gerenciamento de Serviços de Comunicação em seu projeto C#:
using Azure.ResourceManager.Communication;
ID de Subscrição
Você precisa saber a ID da sua assinatura do Azure. Isto pode ser adquirido no portal:
- Entre em sua conta no portal do Azure.
- Na barra lateral esquerda, selecione Assinaturas.
- selecione a subscrição que quer utilizar.
- Clique em Descrição geral.
- Selecione o seu ID de Subscrição.
Para que os exemplos neste início rápido funcionem, você precisa armazenar sua ID de 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, você deve primeiro autenticar-se no Azure. Normalmente, você fará isso usando uma identidade de entidade de serviço.
Opção 1: Identidade gerenciada
Se seu código estiver sendo executado como um serviço no Azure, a maneira mais fácil de autenticar é adquirir uma identidade gerenciada do Azure. Para obter mais informações, consulte:
Identidade gerenciada atribuída pelo sistema
using Azure.Identity;
using Azure.ResourceManager.Communication;
using Azure.ResourceManager.Communication.Models;
using System;
...
var subscriptionId = "AZURE_SUBSCRIPTION_ID";
var acsClient = new CommunicationManagementClient(subscriptionId, new ManagedIdentityCredential());
Identidade gerenciada atribuída pelo usuário
ClientId da identidade gerenciada que você criou deve ser passado para o ManagedIdentityCredential
explicitamente.
using Azure.Identity;
using Azure.ResourceManager.Communication;
using Azure.ResourceManager.Communication.Models;
using System;
...
var subscriptionId = "AZURE_SUBSCRIPTION_ID";
var managedIdentityCredential = new ManagedIdentityCredential("AZURE_CLIENT_ID");
var acsClient = new CommunicationManagementClient(subscriptionId, managedIdentityCredential);
Opção 2: Entidade de serviço
Em vez de usar uma identidade gerenciada, talvez você queira autenticar no Azure usando uma entidade de serviço que você mesmo gerencia. Para obter mais informações, consulte criando e gerenciando uma entidade de serviço no Microsoft Entra ID.
Depois de criar sua entidade de serviço, você precisa coletar as seguintes informações sobre ela no portal do Azure:
- ID de Cliente
- Segredo do Cliente
- ID do Inquilino
Armazene esses valores como variáveis de ambiente denominadas AZURE_CLIENT_ID
, AZURE_CLIENT_SECRET
e AZURE_TENANT_ID
, respectivamente. Em seguida, você pode criar um cliente de gerenciamento de Serviços de Comunicação como este:
using Azure.Identity;
using Azure.ResourceManager.Communication;
using Azure.ResourceManager.Communication.Models;
using System;
...
var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
var acsClient = new CommunicationManagementClient(subscriptionId, new EnvironmentCredential());
Opção 3: Identidade do usuário
Se quiser chamar o Azure em nome de um usuário interativo, em vez de usar uma identidade de serviço, você pode usar o código a seguir para criar um cliente de Gerenciamento de Serviços de Comunicação do Azure. Isso abre uma janela do navegador para solicitar ao usuário suas credenciais MSA ou Microsoft Entra.
using Azure.Identity;
using Azure.ResourceManager.Communication;
using Azure.ResourceManager.Communication.Models;
using System;
...
var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
var communicationServiceClient = new CommunicationManagementClient(subscriptionId, new InteractiveBrowserCredential());
Gerenciando recursos de serviços de comunicação
Interagindo com recursos do Azure
Agora que você está autenticado, pode usar seu cliente de gerenciamento para fazer chamadas de API.
Para cada um dos exemplos a seguir, atribuímos nossos recursos de Serviços de Comunicação a um grupo de recursos existente.
Se precisar de criar um grupo de recursos, pode fazê-lo utilizando o portal do Azure ou o SDK do Azure Resource Manager.
Criar e gerenciar um recurso de Serviços de Comunicação
Você pode usar a instância do cliente SDK de Gerenciamento de Serviços de Comunicação (Azure.ResourceManager.Communication.CommunicationManagementClient
) para executar operações em recursos do Serviço de Comunicação.
Criar um recurso do Communication Services
Ao criar um recurso dos Serviços de Comunicação, especifique o nome do grupo de recursos e o nome do recurso. A Location
propriedade é sempre global
, e durante a visualização pública o DataLocation
valor deve ser UnitedStates
.
var resourceGroupName = "myResourceGroupName";
var resourceName = "myResource";
var resource = new CommunicationServiceResource { Location = "Global", DataLocation = "UnitedStates" };
var operation = await acsClient.CommunicationService.StartCreateOrUpdateAsync(resourceGroupName, resourceName, resource);
await operation.WaitForCompletionAsync();
Atualizar um recurso dos Serviços de Comunicação
...
var resourceGroupName = "myResourceGroupName";
var resourceName = "myResource";
var resource = new CommunicationServiceResource { Location = "Global", DataLocation = "UnitedStates" };
resource.Tags.Add("environment","test");
resource.Tags.Add("department","tech");
// Use existing resource name and new resource object
var operation = await acsClient.CommunicationService.StartCreateOrUpdateAsync(resourceGroupName, resourceName, resource);
await operation.WaitForCompletionAsync();
Listar todos os recursos dos Serviços de Comunicação
var resources = acsClient.CommunicationService.ListBySubscription();
foreach (var resource in resources)
{
Console.WriteLine(resource.Name);
}
Excluir um recurso dos Serviços de Comunicação
var resourceGroupName = "myResourceGroupName";
var resourceName = "myResource";
await acsClient.CommunicationService.StartDeleteAsync(resourceGroupName, resourceName);
Gerenciando chaves e cadeias de conexão
Cada recurso dos Serviços de Comunicação tem um par de chaves de acesso e cadeias de conexão correspondentes. Você pode acessar essas chaves usando o SDK de Gerenciamento e disponibilizá-las para outros SDKs de Serviços de Comunicação para se autenticarem nos Serviços de Comunicação do Azure.
Obter chaves de acesso para um recurso dos Serviços de Comunicação
var resourceGroupName = "myResourceGroupName";
var resourceName = "myResource";
var keys = await acsClient.CommunicationService.ListKeysAsync(resourceGroupName, resourceName);
Console.WriteLine(keys.Value.PrimaryConnectionString);
Console.WriteLine(keys.Value.SecondaryConnectionString);
Regenerar uma chave de acesso para um recurso dos Serviços de Comunicação
var resourceGroupName = "myResourceGroupName";
var resourceName = "myResource";
var keyParams = new RegenerateKeyParameters { KeyType = KeyType.Primary };
var keys = await acsClient.CommunicationService.RegenerateKeyAsync(resourceGroupName, resourceName, keyParams);
Console.WriteLine(keys.Value.PrimaryKey);
Pré-requisitos
- Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
- Instalar o módulo Azure Az PowerShell
Se você estiver planejando usar números de telefone, não poderá usar a conta de avaliação gratuita. Verifique se a sua subscrição cumpre todos os requisitos se planeia comprar números de telefone antes de criar o seu recurso.
Criar o recurso do Azure Communication Services
Para criar um recurso dos Serviços de Comunicação do Azure, entre na CLI do Azure. Você pode criar um recurso através do terminal usando o Connect-AzAccount
comando e fornecendo suas credenciais.
Primeiro, instale o módulo Serviços de Comunicação do Azure usando o comando Az.Communication
a seguir.
PS C:\> Install-Module Az.Communication
Execute o seguinte comando para criar o recurso:
PS C:\> New-AzCommunicationService -ResourceGroupName ContosoResourceProvider1 -Name ContosoAcsResource1 -DataLocation UnitedStates -Location Global
Se você quiser selecionar uma assinatura específica, você também pode especificar o --subscription
sinalizador e fornecer o ID da assinatura.
PS C:\> New-AzCommunicationService -ResourceGroupName ContosoResourceProvider1 -Name ContosoAcsResource1 -DataLocation UnitedStates -Location Global -SubscriptionId SubscriptionID
Você pode configurar seu recurso de Serviços de Comunicação com as seguintes opções:
- O grupo de recursos
- O nome do recurso Serviços de Comunicação
- A geografia a associar ao recurso
Na próxima etapa, você pode atribuir tags ao recurso. Você pode usar tags para organizar seus recursos do Azure. Para obter mais informações, consulte Usar marcas para organizar seus recursos do Azure e hierarquia de gerenciamento.
Gerenciar seu recurso de Serviços de Comunicação
Para adicionar marcas ao recurso dos Serviços de Comunicação, execute os seguintes comandos. Você também pode segmentar uma assinatura específica.
PS C:\> Update-AzCommunicationService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="ExampleValue1"}
PS C:\> Update-AzCommunicationService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="ExampleValue1"} -SubscriptionId SubscriptionID
Para listar todos os seus Recursos dos Serviços de Comunicação do Azure para uma determinada assinatura, use o seguinte comando:
PS C:\> Get-AzCommunicationService -SubscriptionId SubscriptionID
Para listar todas as informações sobre um determinado recurso, use o seguinte comando:
PS C:\> Get-AzCommunicationService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1
Acesse suas cadeias de conexão e pontos de extremidade de serviço
As cadeias de conexão permitem que os SDKs dos Serviços de Comunicação se conectem e se autentiquem no Azure. Você pode acessar suas cadeias de conexão e pontos de extremidade de serviço dos Serviços de Comunicação a partir do portal do Azure ou programaticamente com as APIs do Azure Resource Manager.
Depois de navegar até o recurso Serviços de Comunicação, selecione Chaves no menu de navegação e copie a Cadeia de conexão ou os valores de Ponto de Extremidade para uso pelos SDKs dos Serviços de Comunicação. Você tem acesso às chaves primária e secundária. Isso pode ser útil quando você deseja fornecer acesso temporário aos recursos dos Serviços de Comunicação a um ambiente de terceiros ou de preparação.
Acessar suas cadeias de conexão e pontos de extremidade de serviço usando a CLI do Azure
Você também pode acessar informações de chave usando a CLI do Azure, como seu grupo de recursos ou as chaves de um recurso específico.
Instale a CLI do Azure e use o seguinte comando para entrar. Você precisa fornecer suas credenciais para se conectar à sua conta do Azure.
az login
Agora você pode acessar informações importantes sobre seus recursos.
az communication list --resource-group "<resourceGroup>"
az communication list-key --name "<acsResourceName>" --resource-group "<resourceGroup>"
Se você quiser selecionar uma assinatura específica, você também pode especificar o --subscription
sinalizador e fornecer o ID da assinatura.
az communication list --resource-group "<resourceGroup>" --subscription "<subscriptionId>"
az communication list-key --name "<acsResourceName>" --resource-group "<resourceGroup>" --subscription "<subscriptionId>"
Armazene sua cadeia de conexão
Os SDKs dos Serviços de Comunicação usam cadeias de conexão para autorizar solicitações feitas aos Serviços de Comunicação. Você tem várias opções para armazenar sua cadeia de conexão:
- Um aplicativo em execução na área de trabalho ou em um dispositivo pode armazenar a cadeia de conexão em um arquivo app.config ou web.config . Adicione a cadeia de conexão à seção AppSettings nesses arquivos.
- Um aplicativo em execução em um Serviço de Aplicativo do Azure pode armazenar a cadeia de conexão nas configurações do aplicativo do Serviço de Aplicativo. Adicione a cadeia de conexão à seção Cadeias de Conexão da guia Configurações do Aplicativo no portal.
- Você pode armazenar sua cadeia de conexão no Cofre da Chave do Azure. Você pode gerenciar ainda mais com segurança sua cadeia de conexão.
- Se você estiver executando seu aplicativo localmente, convém armazenar sua cadeia de conexão em uma variável de ambiente.
Armazene sua cadeia de conexão em uma variável de ambiente
Para configurar uma variável de ambiente, abra uma janela do console e selecione seu sistema operacional nas guias a seguir. Substitua <yourconnectionstring>
pela cadeia de conexão real.
Abra uma janela do console e digite o seguinte comando:
setx COMMUNICATION_SERVICES_CONNECTION_STRING "<yourConnectionString>"
Depois de adicionar a variável de ambiente, talvez seja necessário reiniciar todos os programas em execução que leem a variável de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.
Clean up resources (Limpar recursos)
Se quiser limpar e remover uma assinatura dos Serviços de Comunicação, você pode excluir o recurso ou grupo de recursos. Para excluir seu recurso de comunicação, execute o seguinte comando.
az communication delete --name "acsResourceName" --resource-group "resourceGroup"
A exclusão do grupo de recursos também exclui quaisquer outros recursos associados a ele.
Se você tiver algum número de telefone atribuído ao seu recurso após a exclusão do recurso, os números de telefone serão automaticamente liberados do seu recurso ao mesmo tempo.
Nota
A exclusão de recursos é permanente e nenhum dado, incluindo filtros de grade de eventos, números de telefone ou outros dados vinculados ao seu recurso, pode ser recuperado se você excluir o recurso.
Próximos passos
Neste guia de início rápido, você aprendeu como:
- Criar um recurso do Communication Services
- Configurar a geografia e as tags de recursos
- Acessar as chaves desse recurso
- Excluir o recurso