Configure bots do Bot Framework para clientes governamentais dos EUA

Artigo
10/09/2024

Este artigo destina-se a clientes governamentais dos EUA que estão implantando bots do Bot Framework e do Serviço de Bot de IA do Azure na nuvem do Microsoft Azure Governamental.

Dica

Os bots no Azure Governamental que se conectam ao Microsoft Teams devem usar o ambiente Microsoft Office 365 Nuvem da Comunidade Governamental (GCC) High.

Este artigo descreve como configurar um bot para trabalhar com a nuvem do Azure Governamental e com o ambiente Office 365 GCC High.

Pré-requisitos

Uma conta na nuvem do Azure Governamental.
Para estender o Teams, um recurso de Bot do Azure criado no ambiente Office 365 GCC High.
O projeto de bot C# ou JavaScript que você deseja configurar.
SDK do Bot Framework versão 4.14 ou posterior.

Use o adaptador de nuvem

Verifique se o bot usa o adaptador de nuvem ou um adaptador derivado do adaptador de nuvem. O adaptador de nuvem permite especificar configurações específicas para a nuvem do Azure Governamental e o ambiente Office 365 GCC High.

C#
JavaScript

A classe ConfigurationBotFrameworkAuthentication lê as configurações de autenticação do arquivo de configuração do bot. O adaptador de nuvem, quando for criado, usará essas configurações de autenticação.

Certifique-se de que o método ConfigureServices no arquivo Startup.cs contenha essa linha.

services.AddSingleton<BotFrameworkAuthentication, ConfigurationBotFrameworkAuthentication>();

O construtor ConfigurationBotFrameworkAuthentication lê as configurações de autenticação do arquivo de configuração do bot.

No arquivo index.js, o código para criar o adaptador deve ter a seguinte aparência:

const botFrameworkAuthentication = new ConfigurationBotFrameworkAuthentication(process.env);

const adapter = new CloudAdapter(botFrameworkAuthentication);

Configurar para o Azure Governamental

A nuvem do Azure Governamental usa https://botframework.azure.us para o ponto de extremidade de serviço de canal. Para a maioria dos canais, a configuração do ponto de extremidade de serviço de canal é suficiente.

Confira a próxima seção para obter as configurações adicionais necessárias para oferecer suporte ao Microsoft Teams no ambiente Office 365 GCC High.

C#
JavaScript

Adicione a configuração a seguir ao arquivo appsettings.json.

"ChannelService": "https://botframework.azure.us",

Adicione a configuração a seguir ao arquivo .env.

ChannelService=https://botframework.azure.us

Configurar para o Office 365 GCC High

Para os serviços do Office 365, são necessárias configurações adicionais para lidar com a autenticação do usuário corretamente. Atualmente, apenas o canal do Microsoft Teams está disponível no ambiente Office 365 GCC High.

C#
JavaScript

Adicione as configurações a seguir ao arquivo appsettings.json.

"ChannelService": "https://botframework.azure.us", 
"OAuthUrl": "https://tokengcch.botframework.azure.us/", 
"ToChannelFromBotLoginUrl": "https://login.microsoftonline.us/MicrosoftServices.onmicrosoft.us",
"ToChannelFromBotOAuthScope": "https://api.botframework.us", 
"ToBotFromChannelTokenIssuer": "https://api.botframework.us", 
"ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.azure.us/v1/.well-known/openidconfiguration",
"ToBotFromEmulatorOpenIdMetadataUrl": "https://login.microsoftonline.us/cab8a31a-1906-4287-a0d8-4eef66b95f6e/v2.0/.well-known/openid-configuration",
"ValidateAuthority": true,

Adicione as configurações a seguir ao arquivo .env.

ChannelService=https://botframework.azure.us
OAuthUrl=https://tokengcch.botframework.azure.us/
ToChannelFromBotLoginUrl=https://login.microsoftonline.us/MicrosoftServices.onmicrosoft.us
ToChannelFromBotOAuthScope=https://api.botframework.us
ToBotFromChannelTokenIssuer=https://api.botframework.us
ToBotFromChannelOpenIdMetadataUrl=https://login.botframework.azure.us/v1/.well-known/openidconfiguration
ToBotFromEmulatorOpenIdMetadataUrl=https://login.microsoftonline.us/cab8a31a-1906-4287-a0d8-4eef66b95f6e/v2.0/.well-known/openid-configuration
ValidateAuthority=true

Configurar para o ambiente DoD

Há também um ambiente DoD que compartilha a maioria (mas não todas) as configurações com o ambiente Office 365 GCC High. Para o ambiente DoD, use as configurações a seguir.

C#
JavaScript

Adicione as configurações a seguir ao arquivo appsettings.json.

"ChannelService": "https://botframework.azure.us", 
"OAuthUrl": "https://apiDoD.botframework.azure.us", 
"ToChannelFromBotLoginUrl": "https://login.microsoftonline.us/MicrosoftServices.onmicrosoft.us",
"ToChannelFromBotOAuthScope": "https://api.botframework.us", 
"ToBotFromChannelTokenIssuer": "https://api.botframework.us", 
"ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.azure.us/v1/.well-known/openidconfiguration",
"ToBotFromEmulatorOpenIdMetadataUrl": "https://login.microsoftonline.us/cab8a31a-1906-4287-a0d8-4eef66b95f6e/v2.0/.well-known/openid-configuration",
"ValidateAuthority": true,

Adicione as configurações a seguir ao arquivo .env.

ChannelService=https://botframework.azure.us
OAuthUrl=https://apiDoD.botframework.azure.us
ToChannelFromBotLoginUrl=https://login.microsoftonline.us/MicrosoftServices.onmicrosoft.us
ToChannelFromBotOAuthScope=https://api.botframework.us
ToBotFromChannelTokenIssuer=https://api.botframework.us
ToBotFromChannelOpenIdMetadataUrl=https://login.botframework.azure.us/v1/.well-known/openidconfiguration
ToBotFromEmulatorOpenIdMetadataUrl=https://login.microsoftonline.us/cab8a31a-1906-4287-a0d8-4eef66b95f6e/v2.0/.well-known/openid-configuration
ValidateAuthority=true

Adicionar autenticação de usuário ao seu bot

Seu bot pode usar vários provedores de identidade para acessar recursos em nome de um usuário, como o Microsoft Entra ID e muitos outros provedores OAuth.

O ambiente Office 365 GCC High usa uma URL de redirecionamento diferente das usadas para outros ambientes. Ao configurar seu bot para autenticação no ambiente Office 365 GCC High, use https://tokengcch.botframework.azure.us/.auth/web/redirect como a URL de redirecionamento OAuth e siga as etapas sobre como adicionar autenticação ao bot.

Informações adicionais

Para obter mais informações sobre o Microsoft Azure Governamental e o Office 365 Government High, confira:

Próximas etapas

Com essas etapas, seu bot deve ser configurado para funcionar com êxito na nuvem do Azure Governamental e no ambiente Office 365 GCC High. Outras referências úteis sobre o Serviço de Bot no Azure Governamental.

Compartilhar via