Merge pull request #3209 from singhvikra-micro/main

cyrilanderson · web-flow · commit fe1a805d479f · 2024-09-25T08:27:16.000-04:00
Enhanced documentation for Azure Bot Service in the China Mooncake (#1)
diff --git a/articles/TOC.yml b/articles/TOC.yml
@@ -205,6 +205,8 @@
       href: provision-azure-bot.md
     - name: Configure an Azure Government bot
       href: how-to-deploy-gov-cloud-high.md
+    - name: Configure a bot in Microsoft Azure operated by 21Vianet
+      href: how-to-deploy-china-cloud.md
     - name: Set up continuous deployment
       displayName: Set up continuous integration and delivery, Set up CI/CD, Set up CICD
       href: bot-service-build-continuous-deployment.md
diff --git a/articles/channel-connect-teams.md b/articles/channel-connect-teams.md
@@ -39,6 +39,7 @@ You can configure your bot to communicate with people via Microsoft Teams. This
 >
 > - The **Calling** tab supports the Teams calling feature. For more information, see [Register calls and meetings bot for Microsoft Teams](/microsoftteams/platform/bots/calls-and-meetings/registering-calling-bot).
 > - The **Publish** tab contains information about how to publish your Teams app to the Teams Store.
+> - The **Microsoft Azure operated by 21Vianet** does not support the **Get bot embed code** feature. To test the Teams channel, create the Teams app and deploy it using the steps mentioned below.
 
 ## Test your bot in Teams
 
diff --git a/articles/how-to-deploy-china-cloud.md b/articles/how-to-deploy-china-cloud.md
@@ -0,0 +1,157 @@
+---
+title: Deploy Bots to Microsoft Azure operated by 21Vianet
+description: Learn how to configure a bot to operate in the Microsoft Azure operated by 21Vianet.
+author: singhvikra-micro
+ms.author: singhvikra
+manager: kunsingh
+ms.reviewer: kparihar
+ms.service: azure-ai-bot-service
+ms.topic: how-to
+ms.date: 09/23/2024
+ms.custom:
+  - template-how-to
+  - evergreen
+---
+
+# Configure a bot in Microsoft Azure operated by 21Vianet
+
+This guide helps Microsoft Azure customers deploy Bot Framework and Azure AI Bot Service bots on the Microsoft Azure platform operated by 21Vianet.
+
+## Prerequisites
+
+- An account in the Microsoft Azure.
+- The C# or JavaScript bot project you want to configure.
+- Bot Framework SDK version 4.14 or later.
+
+## Use the cloud adapter
+
+Make sure that your bot uses the _cloud adapter_, or an adapter that derives from the cloud adapter.
+The cloud adapter lets you specify settings specific to the Microsoft Azure Cloud.
+
+### [C#](#tab/csharp)
+
+The `ConfigurationBotFrameworkAuthentication` class reads authentication settings from your bot configuration file. Upon creation, the cloud adapter utilizes these authentication settings.
+
+Make sure that the `ConfigureServices` method in your **Startup.cs** file contains this line.
+
+```csharp
+services.AddSingleton<BotFrameworkAuthentication, ConfigurationBotFrameworkAuthentication>();
+```
+
+### [JavaScript](#tab/javascript)
+
+The `ConfigurationBotFrameworkAuthentication` constructor reads authentication settings from your bot configuration file.
+
+In your **index.js** file, the code to create your adapter should look like this:
+
+```javascript
+const botFrameworkAuthentication = new ConfigurationBotFrameworkAuthentication(process.env);
+
+const adapter = new CloudAdapter(botFrameworkAuthentication);
+```
+
+---
+
+## Configure UserAssignedMSI/SingleTenant Bot
+
+To ensure the bot functions correctly in the Microsoft Azure Cloud, extra authentication settings are necessary. Replace the "App-Tenant-ID" with the bot's tenant ID.
+
+### [C#](#tab/csharp)
+
+Add the following settings to your **appsettings.json** file.
+
+```json
+"OAuthUrl": "https://token.botframework.azure.cn/", 
+"ToChannelFromBotLoginUrl": "https://login.partner.microsoftonline.cn/<App-Tenant-ID>",
+"ToChannelFromBotOAuthScope": "https://api.botframework.azure.cn",
+"ToBotFromChannelTokenIssuer": "https://api.botframework.azure.cn",
+"ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.azure.cn/v1/.well-known/openidconfiguration",
+"ToBotFromEmulatorOpenIdMetadataUrl": "https://login.partner.microsoftonline.cn/a55a4d5b-9241-49b1-b4ff-befa8db00269/v2.0/.well-known/openid-configuration",
+"ValidateAuthority": true
+```
+
+### [JavaScript](#tab/javascript)
+
+Add the following settings to your **.env** file.
+
+```ini
+OAuthUrl=https://token.botframework.azure.cn/, 
+ToChannelFromBotLoginUrl=https://login.partner.microsoftonline.cn/<App-Tenant-Id>,
+ToChannelFromBotOAuthScope=https://api.botframework.azure.cn,
+ToBotFromChannelTokenIssuer=https://api.botframework.azure.cn,
+ToBotFromChannelOpenIdMetadataUrl=https://login.botframework.azure.cn/v1/.well-known/openidconfiguration,
+ToBotFromEmulatorOpenIdMetadataUrl=https://login.partner.microsoftonline.cn/a55a4d5b-9241-49b1-b4ff-befa8db00269/v2.0/.well-known/openid-configuration,
+ValidateAuthority=true
+```
+
+---
+
+## Configure MultiTenant Bot
+
+For the multitenant bot, use the following settings.
+
+### [C#](#tab/csharp)
+
+Add the following settings to your **appsettings.json** file.
+
+```json
+"OAuthUrl": "https://token.botframework.azure.cn/", 
+"ToChannelFromBotLoginUrl": "https://login.partner.microsoftonline.cn/microsoftservices.partner.onmschina.cn",
+"ToChannelFromBotOAuthScope": "https://api.botframework.azure.cn",
+"ToBotFromChannelTokenIssuer": "https://api.botframework.azure.cn",
+"ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.azure.cn/v1/.well-known/openidconfiguration",
+"ToBotFromEmulatorOpenIdMetadataUrl": "https://login.partner.microsoftonline.cn/a55a4d5b-9241-49b1-b4ff-befa8db00269/v2.0/.well-known/openid-configuration",
+"ValidateAuthority": true
+```
+
+### [JavaScript](#tab/javascript)
+
+Add the following settings to your **.env** file.
+
+```ini
+OAuthUrl=https://token.botframework.azure.cn/, 
+ToChannelFromBotLoginUrl=https://login.partner.microsoftonline.cn/microsoftservices.partner.onmschina.cn,
+ToChannelFromBotOAuthScope=https://api.botframework.azure.cn,
+ToBotFromChannelTokenIssuer=https://api.botframework.azure.cn,
+ToBotFromChannelOpenIdMetadataUrl=https://login.botframework.azure.cn/v1/.well-known/openidconfiguration,
+ToBotFromEmulatorOpenIdMetadataUrl=https://login.partner.microsoftonline.cn/a55a4d5b-9241-49b1-b4ff-befa8db00269/v2.0/.well-known/openid-configuration,
+ValidateAuthority=true
+```
+
+--- 
+
+## Add user authentication to your bot
+
+Your bot can use various identity providers to access resources on behalf of a user, such as Microsoft Entra ID and many other OAuth providers.
+
+The Microsoft Azure Cloud uses a redirect URL that is different from the ones used for other environments.
+To configuring your bot for authentication, use `https://token.botframework.azure.cn/.auth/web/redirect` as the OAuth redirect URL and follow the steps in how to [add authentication to your bot](v4sdk/bot-builder-authentication.md).
+
+---
+
+## Configure a bot to run on one or more channels
+
+To configure a bot to connect to a channel, complete the following steps:
+
+1. Sign in to the [Azure portal](https://portal.azure.cn).
+2. Select the bot that you want to configure.
+3. In the left pane, select **Channels** under **Settings**.
+4. In the right pane, select the icon of the channel you want to add to your bot. You may need to scroll down to see the list of all **Available Channels**. The connection steps vary for each channel. For more information on supported channels, see the related articles.
+
+| Channel | Description |
+|:-|:-|
+| [Direct Line](bot-service-channel-directline.md) | Integrate a bot into a mobile app, web page, or other applications. |
+| [Microsoft Teams](channel-connect-teams.md) | Configure a bot to communicate with users through Microsoft Teams. |
+| [Web Chat](bot-service-channel-connect-webchat.md) | Automatically configured for you when you create a bot with the Bot Framework Service. |
+
+---
+
+## Next steps
+
+With these steps, your bot should be configured to work successfully. Other useful references regarding Bot Service.
+
+- [Tutorial: Deploy a basic bot using Azure AI Bot Service](tutorial-publish-a-bot.md)
+- [Add authentication to a bot in Bot Framework SDK](v4sdk/bot-builder-authentication.md)
+- [Connect a bot to Web Chat in the Bot Framework SDK](bot-service-channel-connect-webchat.md)
+- [Authenticate requests with the Bot Connector API](rest-api/bot-framework-rest-connector-authentication.md)
+- [Compliance in the Azure AI Bot Service](bot-service-compliance.md)
diff --git a/articles/ref-oauth-redirect-urls.md b/articles/ref-oauth-redirect-urls.md
@@ -18,9 +18,9 @@ Azure AI Bot Service provides different OAuth and OAuth redirect URLs to meet sp
 
 - The bot needs the OAuth URL at run time.
 - You need to provide the OAuth redirect URL when you create or configure your OAuth identity provider.
-- For more information, see [how to add authentication to your a bot](v4sdk/bot-builder-authentication.md).
+- For more information, see [how to add authentication to your bot](v4sdk/bot-builder-authentication.md).
 
-Choose the URLs to use with your bot and identity provider based on your data residency requirements and whether your bot is in the public cloud or the Microsoft Azure Government cloud.
+Choose the URLs to use with your bot and identity provider based on your data residency requirements and whether your bot is in the public cloud or the Microsoft Azure Government cloud or the Microsoft Azure operated by 21Vianet.
 
 | Data residency | Cloud            | OAuth URL                                     | OAuth Redirect URL                                               |
 |:---------------|:-----------------|:----------------------------------------------|:-----------------------------------------------------------------|
@@ -29,6 +29,7 @@ Choose the URLs to use with your bot and identity provider based on your data re
 | United States  | Public           | `https://unitedstates.token.botframework.com` | `https://unitedstates.token.botframework.com/.auth/web/redirect` |
 | India         | Public           | `https://india.token.botframework.com`       | `https://india.token.botframework.com/.auth/web/redirect`       |
 | None           | Azure Government | `https://token.botframework.azure.us`         | `https://token.botframework.azure.us/.auth/web/redirect`         |
+| None           | Azure operated by 21Vianet | `https://token.botframework.azure.cn`         | `https://token.botframework.azure.cn/.auth/web/redirect`         |
 
 The default OAuth and OAuth redirect URLs are `https://token.botframework.com` and `https://token.botframework.com/.auth/web/redirect`, which can be used for public-cloud bots with no data residency requirements.
 
@@ -62,3 +63,4 @@ See these articles for related information.
 - [Regionalization in Azure AI Bot Service](v4sdk/bot-builder-concept-regionalization.md)
 - [Bot Framework authentication basics](v4sdk/bot-builder-authentication-basics.md)
 - [Configure Bot Framework bots for US Government customers](how-to-deploy-gov-cloud-high.md)
+- [Configure a bot in Microsoft Azure operated by 21Vianet](how-to-deploy-china-cloud.md)

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ You can configure your bot to communicate with people via Microsoft Teams. This`
`39`	`39`	`>`
`40`	`40`	`> - The Calling tab supports the Teams calling feature. For more information, see [Register calls and meetings bot for Microsoft Teams](/microsoftteams/platform/bots/calls-and-meetings/registering-calling-bot).`
`41`	`41`	`> - The Publish tab contains information about how to publish your Teams app to the Teams Store.`
	`42`	`+> - The Microsoft Azure operated by 21Vianet does not support the Get bot embed code feature. To test the Teams channel, create the Teams app and deploy it using the steps mentioned below.`
`42`	`43`
`43`	`44`	`## Test your bot in Teams`
`44`	`45`