Azure Mgmt Botservice Dotnet

作者 microsoft354361d83247MIT收录于 2026年10月8日更新于 2026年10月8日

Azure Resource Manager SDK for Bot Service in .NET. Management plane operations for creating and managing Azure Bot resources, channels (Teams, DirectLine, Slack), and connection settings. Triggers: "Bot Service", "BotResource", "Azure Bot", "DirectLine channel", "Teams channel", "bot management .NET", "create bot".

AI 生成的概览

指导 .NET 开发者使用 Azure Resource Manager SDK 预配和管理 Azure Bot Service 资源。

功能
该技能说明如何使用 Azure.ResourceManager.BotService .NET SDK,通过 Azure Resource Manager 创建、更新、列出和删除 Azure Bot 资源。内容涵盖配置 DirectLine、Microsoft Teams、Web Chat、Slack 等通道、重新生成 DirectLine 密钥,以及使用 DefaultAzureCredential 进行身份验证。还列出了关键类型、SKU 与应用类型取值、错误处理模式和相关 SDK。
适用场景
适用于编写管理 Azure Bot Service 资源的 .NET 代码,例如预配机器人或配置通道。它面向管理平面任务,而非构建机器人对话逻辑。
运行要求
需要 .NET SDK 以及 Azure.ResourceManager.BotService 和 Azure.Identity NuGet 包、Azure 订阅,以及 DefaultAzureCredential 或服务主体等凭据。需要访问 Azure Resource Manager 的网络连接。该技能不附带脚本。

Azure.ResourceManager.BotService (.NET)

Management plane SDK for provisioning and managing Azure Bot Service resources via Azure Resource Manager.

Installation

bash
dotnet add package Azure.ResourceManager.BotServicedotnet add package Azure.Identity

Current Versions: Stable v1.1.1, Preview v1.1.0-beta.1

Environment Variables

bash
AZURE_SUBSCRIPTION_ID=<your-subscription-id> # Required: Azure subscription IDAZURE_TOKEN_CREDENTIALS=prod  # Required only if DefaultAzureCredential is used in productionAZURE_TENANT_ID=<tenant-id> # For service principal auth (optional)AZURE_CLIENT_ID=<client-id> # For service principal auth (optional)AZURE_CLIENT_SECRET=<client-secret> # For service principal auth (optional)

Authentication

csharp
using Azure.Identity;using Azure.ResourceManager;using Azure.ResourceManager.BotService;
// Local dev: DefaultAzureCredential. Production: set AZURE_TOKEN_CREDENTIALS=prod or AZURE_TOKEN_CREDENTIALS=<specific_credential>var credential = new DefaultAzureCredential(    DefaultAzureCredential.DefaultEnvironmentVariableName);// Or use a specific credential directly in production:// See https://learn.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet#credential-classes// var credential = new ManagedIdentityCredential();ArmClient armClient = new ArmClient(credential);
// Get subscription and resource groupSubscriptionResource subscription = await armClient.GetDefaultSubscriptionAsync();ResourceGroupResource resourceGroup = await subscription.GetResourceGroups().GetAsync("myResourceGroup");
// Access bot collectionBotCollection botCollection = resourceGroup.GetBots();

Resource Hierarchy

ArmClient└── SubscriptionResource    └── ResourceGroupResource        └── BotResource            ├── BotChannelResource (DirectLine, Teams, Slack, etc.)            ├── BotConnectionSettingResource (OAuth connections)            └── BotServicePrivateEndpointConnectionResource

Core Workflows

1. Create Bot Resource

csharp
using Azure.ResourceManager.BotService;using Azure.ResourceManager.BotService.Models;
// Create bot datavar botData = new BotData(AzureLocation.WestUS2){    Kind = BotServiceKind.Azurebot,    Sku = new BotServiceSku(BotServiceSkuName.F0),    Properties = new BotProperties(        displayName: "MyBot",        endpoint: new Uri("https://mybot.azurewebsites.net/api/messages"),        msaAppId: "<your-msa-app-id>")    {        Description = "My Azure Bot",        MsaAppType = BotMsaAppType.MultiTenant    }};
// Create or update the botArmOperation<BotResource> operation = await botCollection.CreateOrUpdateAsync(    WaitUntil.Completed,     "myBotName",     botData);    BotResource bot = operation.Value;Console.WriteLine($"Bot created: {bot.Data.Name}");

2. Configure DirectLine Channel

csharp
// Get the botBotResource bot = await resourceGroup.GetBots().GetAsync("myBotName");
// Get channel collectionBotChannelCollection channels = bot.GetBotChannels();
// Create DirectLine channel configurationvar channelData = new BotChannelData(AzureLocation.WestUS2){    Properties = new DirectLineChannel()    {        Properties = new DirectLineChannelProperties()        {            Sites =             {                new DirectLineSite("Default Site")                {                    IsEnabled = true,                    IsV1Enabled = false,                    IsV3Enabled = true,                    IsSecureSiteEnabled = true                }            }        }    }};
// Create or update the channelArmOperation<BotChannelResource> channelOp = await channels.CreateOrUpdateAsync(    WaitUntil.Completed,    BotChannelName.DirectLineChannel,    channelData);
Console.WriteLine("DirectLine channel configured");

3. Configure Microsoft Teams Channel

csharp
var teamsChannelData = new BotChannelData(AzureLocation.WestUS2){    Properties = new MsTeamsChannel()    {        Properties = new MsTeamsChannelProperties()        {            IsEnabled = true,            EnableCalling = false        }    }};
await channels.CreateOrUpdateAsync(    WaitUntil.Completed,    BotChannelName.MsTeamsChannel,    teamsChannelData);

4. Configure Web Chat Channel

csharp
var webChatChannelData = new BotChannelData(AzureLocation.WestUS2){    Properties = new WebChatChannel()    {        Properties = new WebChatChannelProperties()        {            Sites =            {                new WebChatSite("Default Site")                {                    IsEnabled = true                }            }        }    }};
await channels.CreateOrUpdateAsync(    WaitUntil.Completed,    BotChannelName.WebChatChannel,    webChatChannelData);

5. Get Bot and List Channels

csharp
// Get botBotResource bot = await botCollection.GetAsync("myBotName");Console.WriteLine($"Bot: {bot.Data.Properties.DisplayName}");Console.WriteLine($"Endpoint: {bot.Data.Properties.Endpoint}");
// List channelsawait foreach (BotChannelResource channel in bot.GetBotChannels().GetAllAsync()){    Console.WriteLine($"Channel: {channel.Data.Name}");}

6. Regenerate DirectLine Keys

csharp
var regenerateRequest = new BotChannelRegenerateKeysContent(BotChannelName.DirectLineChannel){    SiteName = "Default Site"};
BotChannelResource channelWithKeys = await bot.GetBotChannelWithRegenerateKeysAsync(regenerateRequest);

7. Update Bot

csharp
BotResource bot = await botCollection.GetAsync("myBotName");
// Update using patchvar updateData = new BotData(bot.Data.Location){    Properties = new BotProperties(        displayName: "Updated Bot Name",        endpoint: bot.Data.Properties.Endpoint,        msaAppId: bot.Data.Properties.MsaAppId)    {        Description = "Updated description"    }};
await bot.UpdateAsync(updateData);

8. Delete Bot

csharp
BotResource bot = await botCollection.GetAsync("myBotName");await bot.DeleteAsync(WaitUntil.Completed);

Supported Channel Types

ChannelConstantClass
Direct LineBotChannelName.DirectLineChannelDirectLineChannel
Direct Line SpeechBotChannelName.DirectLineSpeechChannelDirectLineSpeechChannel
Microsoft TeamsBotChannelName.MsTeamsChannelMsTeamsChannel
Web ChatBotChannelName.WebChatChannelWebChatChannel
SlackBotChannelName.SlackChannelSlackChannel
FacebookBotChannelName.FacebookChannelFacebookChannel
EmailBotChannelName.EmailChannelEmailChannel
TelegramBotChannelName.TelegramChannelTelegramChannel
TelephonyBotChannelName.TelephonyChannelTelephonyChannel

Key Types Reference

TypePurpose
ArmClientEntry point for all ARM operations
BotResourceRepresents an Azure Bot resource
BotCollectionCollection for bot CRUD
BotDataBot resource definition
BotPropertiesBot configuration properties
BotChannelResourceChannel configuration
BotChannelCollectionCollection of channels
BotChannelDataChannel configuration data
BotConnectionSettingResourceOAuth connection settings

BotServiceKind Values

ValueDescription
BotServiceKind.AzurebotAzure Bot (recommended)
BotServiceKind.BotLegacy Bot Framework bot
BotServiceKind.DesignerComposer bot
BotServiceKind.FunctionFunction bot
BotServiceKind.SdkSDK bot

BotServiceSkuName Values

ValueDescription
BotServiceSkuName.F0Free tier
BotServiceSkuName.S1Standard tier

BotMsaAppType Values

ValueDescription
BotMsaAppType.MultiTenantMulti-tenant app
BotMsaAppType.SingleTenantSingle-tenant app
BotMsaAppType.UserAssignedMSIUser-assigned managed identity

Best Practices

  1. Use DefaultAzureCredential — supports multiple auth methods
  2. Use WaitUntil.Completed for synchronous operations
  3. Handle RequestFailedException for API errors
  4. Use async methods (*Async) for all operations
  5. Store MSA App credentials securely — use Key Vault for secrets
  6. Use managed identity (BotMsaAppType.UserAssignedMSI) for production bots
  7. Enable secure sites for DirectLine channels in production

Error Handling

csharp
using Azure;
try{    var operation = await botCollection.CreateOrUpdateAsync(        WaitUntil.Completed,         botName,         botData);}catch (RequestFailedException ex) when (ex.Status == 409){    Console.WriteLine("Bot already exists");}catch (RequestFailedException ex){    Console.WriteLine($"ARM Error: {ex.Status} - {ex.ErrorCode}: {ex.Message}");}

Related SDKs

SDKPurposeInstall
Azure.ResourceManager.BotServiceBot management (this SDK)dotnet add package Azure.ResourceManager.BotService
Microsoft.Bot.BuilderBot Framework SDKdotnet add package Microsoft.Bot.Builder
Microsoft.Bot.Builder.Integration.AspNet.CoreASP.NET Core integrationdotnet add package Microsoft.Bot.Builder.Integration.AspNet.Core

Reference Links

来源与署名

来源:microsoft/skills位于.github/plugins/azure-sdk-dotnet/skills/azure-mgmt-botservice-dotnet提交354361d

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架