Azure Mgmt Botservice Dotnet

1---
2name: azure-mgmt-botservice-dotnet
3description: |
4  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".
5package: Azure.ResourceManager.BotService
6---
7 
8# Azure.ResourceManager.BotService (.NET)
9 
10Management plane SDK for provisioning and managing Azure Bot Service resources via Azure Resource Manager.
11 
12## Installation
13 
14```bash
15dotnet add package Azure.ResourceManager.BotService
16dotnet add package Azure.Identity
17```
18 
19**Current Versions**: Stable v1.1.1, Preview v1.1.0-beta.1
20 
21## Environment Variables
22 
23```bash
24AZURE_SUBSCRIPTION_ID=<your-subscription-id>
25# For service principal auth (optional)
26AZURE_TENANT_ID=<tenant-id>
27AZURE_CLIENT_ID=<client-id>
28AZURE_CLIENT_SECRET=<client-secret>
29```
30 
31## Authentication
32 
33```csharp
34using Azure.Identity;
35using Azure.ResourceManager;
36using Azure.ResourceManager.BotService;
37 
38// Authenticate using DefaultAzureCredential
39var credential = new DefaultAzureCredential();
40ArmClient armClient = new ArmClient(credential);
41 
42// Get subscription and resource group
43SubscriptionResource subscription = await armClient.GetDefaultSubscriptionAsync();
44ResourceGroupResource resourceGroup = await subscription.GetResourceGroups().GetAsync("myResourceGroup");
45 
46// Access bot collection
47BotCollection botCollection = resourceGroup.GetBots();
48```
49 
50## Resource Hierarchy
51 
52```
53ArmClient
54└── SubscriptionResource
55    └── ResourceGroupResource
56        └── BotResource
57            ├── BotChannelResource (DirectLine, Teams, Slack, etc.)
58            ├── BotConnectionSettingResource (OAuth connections)
59            └── BotServicePrivateEndpointConnectionResource
60```
61 
62## Core Workflows
63 
64### 1. Create Bot Resource
65 
66```csharp
67using Azure.ResourceManager.BotService;
68using Azure.ResourceManager.BotService.Models;
69 
70// Create bot data
71var botData = new BotData(AzureLocation.WestUS2)
72{
73    Kind = BotServiceKind.Azurebot,
74    Sku = new BotServiceSku(BotServiceSkuName.F0),
75    Properties = new BotProperties(
76        displayName: "MyBot",
77        endpoint: new Uri("https://mybot.azurewebsites.net/api/messages"),
78        msaAppId: "<your-msa-app-id>")
79    {
80        Description = "My Azure Bot",
81        MsaAppType = BotMsaAppType.MultiTenant
82    }
83};
84 
85// Create or update the bot
86ArmOperation<BotResource> operation = await botCollection.CreateOrUpdateAsync(
87    WaitUntil.Completed, 
88    "myBotName", 
89    botData);
90    
91BotResource bot = operation.Value;
92Console.WriteLine($"Bot created: {bot.Data.Name}");
93```
94 
95### 2. Configure DirectLine Channel
96 
97```csharp
98// Get the bot
99BotResource bot = await resourceGroup.GetBots().GetAsync("myBotName");
100 
101// Get channel collection
102BotChannelCollection channels = bot.GetBotChannels();
103 
104// Create DirectLine channel configuration
105var channelData = new BotChannelData(AzureLocation.WestUS2)
106{
107    Properties = new DirectLineChannel()
108    {
109        Properties = new DirectLineChannelProperties()
110        {
111            Sites = 
112            {
113                new DirectLineSite("Default Site")
114                {
115                    IsEnabled = true,
116                    IsV1Enabled = false,
117                    IsV3Enabled = true,
118                    IsSecureSiteEnabled = true
119                }
120            }
121        }
122    }
123};
124 
125// Create or update the channel
126ArmOperation<BotChannelResource> channelOp = await channels.CreateOrUpdateAsync(
127    WaitUntil.Completed,
128    BotChannelName.DirectLineChannel,
129    channelData);
130 
131Console.WriteLine("DirectLine channel configured");
132```
133 
134### 3. Configure Microsoft Teams Channel
135 
136```csharp
137var teamsChannelData = new BotChannelData(AzureLocation.WestUS2)
138{
139    Properties = new MsTeamsChannel()
140    {
141        Properties = new MsTeamsChannelProperties()
142        {
143            IsEnabled = true,
144            EnableCalling = false
145        }
146    }
147};
148 
149await channels.CreateOrUpdateAsync(
150    WaitUntil.Completed,
151    BotChannelName.MsTeamsChannel,
152    teamsChannelData);
153```
154 
155### 4. Configure Web Chat Channel
156 
157```csharp
158var webChatChannelData = new BotChannelData(AzureLocation.WestUS2)
159{
160    Properties = new WebChatChannel()
161    {
162        Properties = new WebChatChannelProperties()
163        {
164            Sites =
165            {
166                new WebChatSite("Default Site")
167                {
168                    IsEnabled = true
169                }
170            }
171        }
172    }
173};
174 
175await channels.CreateOrUpdateAsync(
176    WaitUntil.Completed,
177    BotChannelName.WebChatChannel,
178    webChatChannelData);
179```
180 
181### 5. Get Bot and List Channels
182 
183```csharp
184// Get bot
185BotResource bot = await botCollection.GetAsync("myBotName");
186Console.WriteLine($"Bot: {bot.Data.Properties.DisplayName}");
187Console.WriteLine($"Endpoint: {bot.Data.Properties.Endpoint}");
188 
189// List channels
190await foreach (BotChannelResource channel in bot.GetBotChannels().GetAllAsync())
191{
192    Console.WriteLine($"Channel: {channel.Data.Name}");
193}
194```
195 
196### 6. Regenerate DirectLine Keys
197 
198```csharp
199var regenerateRequest = new BotChannelRegenerateKeysContent(BotChannelName.DirectLineChannel)
200{
201    SiteName = "Default Site"
202};
203 
204BotChannelResource channelWithKeys = await bot.GetBotChannelWithRegenerateKeysAsync(regenerateRequest);
205```
206 
207### 7. Update Bot
208 
209```csharp
210BotResource bot = await botCollection.GetAsync("myBotName");
211 
212// Update using patch
213var updateData = new BotData(bot.Data.Location)
214{
215    Properties = new BotProperties(
216        displayName: "Updated Bot Name",
217        endpoint: bot.Data.Properties.Endpoint,
218        msaAppId: bot.Data.Properties.MsaAppId)
219    {
220        Description = "Updated description"
221    }
222};
223 
224await bot.UpdateAsync(updateData);
225```
226 
227### 8. Delete Bot
228 
229```csharp
230BotResource bot = await botCollection.GetAsync("myBotName");
231await bot.DeleteAsync(WaitUntil.Completed);
232```
233 
234## Supported Channel Types
235 
236| Channel | Constant | Class |
237|---------|----------|-------|
238| Direct Line | `BotChannelName.DirectLineChannel` | `DirectLineChannel` |
239| Direct Line Speech | `BotChannelName.DirectLineSpeechChannel` | `DirectLineSpeechChannel` |
240| Microsoft Teams | `BotChannelName.MsTeamsChannel` | `MsTeamsChannel` |
241| Web Chat | `BotChannelName.WebChatChannel` | `WebChatChannel` |
242| Slack | `BotChannelName.SlackChannel` | `SlackChannel` |
243| Facebook | `BotChannelName.FacebookChannel` | `FacebookChannel` |
244| Email | `BotChannelName.EmailChannel` | `EmailChannel` |
245| Telegram | `BotChannelName.TelegramChannel` | `TelegramChannel` |
246| Telephony | `BotChannelName.TelephonyChannel` | `TelephonyChannel` |
247 
248## Key Types Reference
249 
250| Type | Purpose |
251|------|---------|
252| `ArmClient` | Entry point for all ARM operations |
253| `BotResource` | Represents an Azure Bot resource |
254| `BotCollection` | Collection for bot CRUD |
255| `BotData` | Bot resource definition |
256| `BotProperties` | Bot configuration properties |
257| `BotChannelResource` | Channel configuration |
258| `BotChannelCollection` | Collection of channels |
259| `BotChannelData` | Channel configuration data |
260| `BotConnectionSettingResource` | OAuth connection settings |
261 
262## BotServiceKind Values
263 
264| Value | Description |
265|-------|-------------|
266| `BotServiceKind.Azurebot` | Azure Bot (recommended) |
267| `BotServiceKind.Bot` | Legacy Bot Framework bot |
268| `BotServiceKind.Designer` | Composer bot |
269| `BotServiceKind.Function` | Function bot |
270| `BotServiceKind.Sdk` | SDK bot |
271 
272## BotServiceSkuName Values
273 
274| Value | Description |
275|-------|-------------|
276| `BotServiceSkuName.F0` | Free tier |
277| `BotServiceSkuName.S1` | Standard tier |
278 
279## BotMsaAppType Values
280 
281| Value | Description |
282|-------|-------------|
283| `BotMsaAppType.MultiTenant` | Multi-tenant app |
284| `BotMsaAppType.SingleTenant` | Single-tenant app |
285| `BotMsaAppType.UserAssignedMSI` | User-assigned managed identity |
286 
287## Best Practices
288 
2891. **Always use `DefaultAzureCredential`** — supports multiple auth methods
2902. **Use `WaitUntil.Completed`** for synchronous operations
2913. **Handle `RequestFailedException`** for API errors
2924. **Use async methods** (`*Async`) for all operations
2935. **Store MSA App credentials securely** — use Key Vault for secrets
2946. **Use managed identity** (`BotMsaAppType.UserAssignedMSI`) for production bots
2957. **Enable secure sites** for DirectLine channels in production
296 
297## Error Handling
298 
299```csharp
300using Azure;
301 
302try
303{
304    var operation = await botCollection.CreateOrUpdateAsync(
305        WaitUntil.Completed, 
306        botName, 
307        botData);
308}
309catch (RequestFailedException ex) when (ex.Status == 409)
310{
311    Console.WriteLine("Bot already exists");
312}
313catch (RequestFailedException ex)
314{
315    Console.WriteLine($"ARM Error: {ex.Status} - {ex.ErrorCode}: {ex.Message}");
316}
317```
318 
319## Related SDKs
320 
321| SDK | Purpose | Install |
322|-----|---------|---------|
323| `Azure.ResourceManager.BotService` | Bot management (this SDK) | `dotnet add package Azure.ResourceManager.BotService` |
324| `Microsoft.Bot.Builder` | Bot Framework SDK | `dotnet add package Microsoft.Bot.Builder` |
325| `Microsoft.Bot.Builder.Integration.AspNet.Core` | ASP.NET Core integration | `dotnet add package Microsoft.Bot.Builder.Integration.AspNet.Core` |
326 
327## Reference Links
328 
329| Resource | URL |
330|----------|-----|
331| NuGet Package | https://www.nuget.org/packages/Azure.ResourceManager.BotService |
332| API Reference | https://learn.microsoft.com/dotnet/api/azure.resourcemanager.botservice |
333| GitHub Source | https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/botservice/Azure.ResourceManager.BotService |
334| Azure Bot Service Docs | https://learn.microsoft.com/azure/bot-service/ |
335