Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. bot
  5. ChannelSms

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.bot.ChannelSms

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a SMS integration for a Bot Channel

Note A bot can only have a single SMS Channel associated with it.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleChannelsRegistration = new azure.bot.ChannelsRegistration("example", {
    name: "example-bcr",
    location: "global",
    resourceGroupName: example.name,
    sku: "F0",
    microsoftAppId: current.then(current => current.clientId),
});
const exampleChannelSms = new azure.bot.ChannelSms("example", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: example.name,
    smsChannelAccountSecurityId: "BG61f7cf5157f439b084e98256409c2815",
    smsChannelAuthToken: "jh8980432610052ed4e29565c5e232f",
    phoneNumber: "+12313803556",
});
Copy
import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_channels_registration = azure.bot.ChannelsRegistration("example",
    name="example-bcr",
    location="global",
    resource_group_name=example.name,
    sku="F0",
    microsoft_app_id=current.client_id)
example_channel_sms = azure.bot.ChannelSms("example",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example.name,
    sms_channel_account_security_id="BG61f7cf5157f439b084e98256409c2815",
    sms_channel_auth_token="jh8980432610052ed4e29565c5e232f",
    phone_number="+12313803556")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/bot"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleChannelsRegistration, err := bot.NewChannelsRegistration(ctx, "example", &bot.ChannelsRegistrationArgs{
			Name:              pulumi.String("example-bcr"),
			Location:          pulumi.String("global"),
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("F0"),
			MicrosoftAppId:    pulumi.String(current.ClientId),
		})
		if err != nil {
			return err
		}
		_, err = bot.NewChannelSms(ctx, "example", &bot.ChannelSmsArgs{
			BotName:                     exampleChannelsRegistration.Name,
			Location:                    exampleChannelsRegistration.Location,
			ResourceGroupName:           example.Name,
			SmsChannelAccountSecurityId: pulumi.String("BG61f7cf5157f439b084e98256409c2815"),
			SmsChannelAuthToken:         pulumi.String("jh8980432610052ed4e29565c5e232f"),
			PhoneNumber:                 pulumi.String("+12313803556"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var current = Azure.Core.GetClientConfig.Invoke();

    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleChannelsRegistration = new Azure.Bot.ChannelsRegistration("example", new()
    {
        Name = "example-bcr",
        Location = "global",
        ResourceGroupName = example.Name,
        Sku = "F0",
        MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
    });

    var exampleChannelSms = new Azure.Bot.ChannelSms("example", new()
    {
        BotName = exampleChannelsRegistration.Name,
        Location = exampleChannelsRegistration.Location,
        ResourceGroupName = example.Name,
        SmsChannelAccountSecurityId = "BG61f7cf5157f439b084e98256409c2815",
        SmsChannelAuthToken = "jh8980432610052ed4e29565c5e232f",
        PhoneNumber = "+12313803556",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.bot.ChannelsRegistration;
import com.pulumi.azure.bot.ChannelsRegistrationArgs;
import com.pulumi.azure.bot.ChannelSms;
import com.pulumi.azure.bot.ChannelSmsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = CoreFunctions.getClientConfig();

        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleChannelsRegistration = new ChannelsRegistration("exampleChannelsRegistration", ChannelsRegistrationArgs.builder()
            .name("example-bcr")
            .location("global")
            .resourceGroupName(example.name())
            .sku("F0")
            .microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
            .build());

        var exampleChannelSms = new ChannelSms("exampleChannelSms", ChannelSmsArgs.builder()
            .botName(exampleChannelsRegistration.name())
            .location(exampleChannelsRegistration.location())
            .resourceGroupName(example.name())
            .smsChannelAccountSecurityId("BG61f7cf5157f439b084e98256409c2815")
            .smsChannelAuthToken("jh8980432610052ed4e29565c5e232f")
            .phoneNumber("+12313803556")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleChannelsRegistration:
    type: azure:bot:ChannelsRegistration
    name: example
    properties:
      name: example-bcr
      location: global
      resourceGroupName: ${example.name}
      sku: F0
      microsoftAppId: ${current.clientId}
  exampleChannelSms:
    type: azure:bot:ChannelSms
    name: example
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${example.name}
      smsChannelAccountSecurityId: BG61f7cf5157f439b084e98256409c2815
      smsChannelAuthToken: jh8980432610052ed4e29565c5e232f
      phoneNumber: '+12313803556'
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
Copy

Create ChannelSms Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ChannelSms(name: string, args: ChannelSmsArgs, opts?: CustomResourceOptions);
@overload
def ChannelSms(resource_name: str,
               args: ChannelSmsArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def ChannelSms(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               bot_name: Optional[str] = None,
               phone_number: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               sms_channel_account_security_id: Optional[str] = None,
               sms_channel_auth_token: Optional[str] = None,
               location: Optional[str] = None)
func NewChannelSms(ctx *Context, name string, args ChannelSmsArgs, opts ...ResourceOption) (*ChannelSms, error)
public ChannelSms(string name, ChannelSmsArgs args, CustomResourceOptions? opts = null)
public ChannelSms(String name, ChannelSmsArgs args)
public ChannelSms(String name, ChannelSmsArgs args, CustomResourceOptions options)

type: azure:bot:ChannelSms
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ChannelSmsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ChannelSmsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ChannelSmsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ChannelSmsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ChannelSmsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var channelSmsResource = new Azure.Bot.ChannelSms("channelSmsResource", new()
{
    BotName = "string",
    PhoneNumber = "string",
    ResourceGroupName = "string",
    SmsChannelAccountSecurityId = "string",
    SmsChannelAuthToken = "string",
    Location = "string",
});
Copy
example, err := bot.NewChannelSms(ctx, "channelSmsResource", &bot.ChannelSmsArgs{
	BotName:                     pulumi.String("string"),
	PhoneNumber:                 pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	SmsChannelAccountSecurityId: pulumi.String("string"),
	SmsChannelAuthToken:         pulumi.String("string"),
	Location:                    pulumi.String("string"),
})
Copy
var channelSmsResource = new ChannelSms("channelSmsResource", ChannelSmsArgs.builder()
    .botName("string")
    .phoneNumber("string")
    .resourceGroupName("string")
    .smsChannelAccountSecurityId("string")
    .smsChannelAuthToken("string")
    .location("string")
    .build());
Copy
channel_sms_resource = azure.bot.ChannelSms("channelSmsResource",
    bot_name="string",
    phone_number="string",
    resource_group_name="string",
    sms_channel_account_security_id="string",
    sms_channel_auth_token="string",
    location="string")
Copy
const channelSmsResource = new azure.bot.ChannelSms("channelSmsResource", {
    botName: "string",
    phoneNumber: "string",
    resourceGroupName: "string",
    smsChannelAccountSecurityId: "string",
    smsChannelAuthToken: "string",
    location: "string",
});
Copy
type: azure:bot:ChannelSms
properties:
    botName: string
    location: string
    phoneNumber: string
    resourceGroupName: string
    smsChannelAccountSecurityId: string
    smsChannelAuthToken: string
Copy

ChannelSms Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ChannelSms resource accepts the following input properties:

BotName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
PhoneNumber This property is required. string
The phone number for the SMS Channel.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
SmsChannelAccountSecurityId This property is required. string
The account security identifier (SID) for the SMS Channel.
SmsChannelAuthToken This property is required. string
The authorization token for the SMS Channel.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
BotName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
PhoneNumber This property is required. string
The phone number for the SMS Channel.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
SmsChannelAccountSecurityId This property is required. string
The account security identifier (SID) for the SMS Channel.
SmsChannelAuthToken This property is required. string
The authorization token for the SMS Channel.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
botName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
phoneNumber This property is required. String
The phone number for the SMS Channel.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
smsChannelAccountSecurityId This property is required. String
The account security identifier (SID) for the SMS Channel.
smsChannelAuthToken This property is required. String
The authorization token for the SMS Channel.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
botName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
phoneNumber This property is required. string
The phone number for the SMS Channel.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
smsChannelAccountSecurityId This property is required. string
The account security identifier (SID) for the SMS Channel.
smsChannelAuthToken This property is required. string
The authorization token for the SMS Channel.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
bot_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
phone_number This property is required. str
The phone number for the SMS Channel.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
sms_channel_account_security_id This property is required. str
The account security identifier (SID) for the SMS Channel.
sms_channel_auth_token This property is required. str
The authorization token for the SMS Channel.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
botName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
phoneNumber This property is required. String
The phone number for the SMS Channel.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
smsChannelAccountSecurityId This property is required. String
The account security identifier (SID) for the SMS Channel.
smsChannelAuthToken This property is required. String
The authorization token for the SMS Channel.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the ChannelSms resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ChannelSms Resource

Get an existing ChannelSms resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ChannelSmsState, opts?: CustomResourceOptions): ChannelSms
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bot_name: Optional[str] = None,
        location: Optional[str] = None,
        phone_number: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sms_channel_account_security_id: Optional[str] = None,
        sms_channel_auth_token: Optional[str] = None) -> ChannelSms
func GetChannelSms(ctx *Context, name string, id IDInput, state *ChannelSmsState, opts ...ResourceOption) (*ChannelSms, error)
public static ChannelSms Get(string name, Input<string> id, ChannelSmsState? state, CustomResourceOptions? opts = null)
public static ChannelSms get(String name, Output<String> id, ChannelSmsState state, CustomResourceOptions options)
resources:  _:    type: azure:bot:ChannelSms    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
BotName Changes to this property will trigger replacement. string
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
PhoneNumber string
The phone number for the SMS Channel.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
SmsChannelAccountSecurityId string
The account security identifier (SID) for the SMS Channel.
SmsChannelAuthToken string
The authorization token for the SMS Channel.
BotName Changes to this property will trigger replacement. string
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
PhoneNumber string
The phone number for the SMS Channel.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
SmsChannelAccountSecurityId string
The account security identifier (SID) for the SMS Channel.
SmsChannelAuthToken string
The authorization token for the SMS Channel.
botName Changes to this property will trigger replacement. String
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
phoneNumber String
The phone number for the SMS Channel.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
smsChannelAccountSecurityId String
The account security identifier (SID) for the SMS Channel.
smsChannelAuthToken String
The authorization token for the SMS Channel.
botName Changes to this property will trigger replacement. string
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
phoneNumber string
The phone number for the SMS Channel.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
smsChannelAccountSecurityId string
The account security identifier (SID) for the SMS Channel.
smsChannelAuthToken string
The authorization token for the SMS Channel.
bot_name Changes to this property will trigger replacement. str
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
phone_number str
The phone number for the SMS Channel.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
sms_channel_account_security_id str
The account security identifier (SID) for the SMS Channel.
sms_channel_auth_token str
The authorization token for the SMS Channel.
botName Changes to this property will trigger replacement. String
The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
phoneNumber String
The phone number for the SMS Channel.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
smsChannelAccountSecurityId String
The account security identifier (SID) for the SMS Channel.
smsChannelAuthToken String
The authorization token for the SMS Channel.

Import

The SMS Integration for a Bot Channel can be imported using the resource id, e.g.

$ pulumi import azure:bot/channelSms:ChannelSms example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.BotService/botServices/botService1/channels/SmsChannel
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure