1. Packages
  2. Azure Classic
  3. API Docs
  4. bot
  5. ChannelLine

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.bot.ChannelLine

Explore with Pulumi AI

Manages a Line integration for a Bot Channel

Note A bot can only have a single Line 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 exampleChannelLine = new azure.bot.ChannelLine("example", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: example.name,
    lineChannels: [{
        accessToken: "asdfdsdfTYUIOIoj1231hkjhk",
        secret: "aagfdgfd123567",
    }],
});
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_line = azure.bot.ChannelLine("example",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example.name,
    line_channels=[{
        "access_token": "asdfdsdfTYUIOIoj1231hkjhk",
        "secret": "aagfdgfd123567",
    }])
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.NewChannelLine(ctx, "example", &bot.ChannelLineArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: example.Name,
			LineChannels: bot.ChannelLineLineChannelArray{
				&bot.ChannelLineLineChannelArgs{
					AccessToken: pulumi.String("asdfdsdfTYUIOIoj1231hkjhk"),
					Secret:      pulumi.String("aagfdgfd123567"),
				},
			},
		})
		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 exampleChannelLine = new Azure.Bot.ChannelLine("example", new()
    {
        BotName = exampleChannelsRegistration.Name,
        Location = exampleChannelsRegistration.Location,
        ResourceGroupName = example.Name,
        LineChannels = new[]
        {
            new Azure.Bot.Inputs.ChannelLineLineChannelArgs
            {
                AccessToken = "asdfdsdfTYUIOIoj1231hkjhk",
                Secret = "aagfdgfd123567",
            },
        },
    });

});
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.ChannelLine;
import com.pulumi.azure.bot.ChannelLineArgs;
import com.pulumi.azure.bot.inputs.ChannelLineLineChannelArgs;
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 exampleChannelLine = new ChannelLine("exampleChannelLine", ChannelLineArgs.builder()
            .botName(exampleChannelsRegistration.name())
            .location(exampleChannelsRegistration.location())
            .resourceGroupName(example.name())
            .lineChannels(ChannelLineLineChannelArgs.builder()
                .accessToken("asdfdsdfTYUIOIoj1231hkjhk")
                .secret("aagfdgfd123567")
                .build())
            .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}
  exampleChannelLine:
    type: azure:bot:ChannelLine
    name: example
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${example.name}
      lineChannels:
        - accessToken: asdfdsdfTYUIOIoj1231hkjhk
          secret: aagfdgfd123567
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
Copy

Create ChannelLine Resource

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

Constructor syntax

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

@overload
def ChannelLine(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                bot_name: Optional[str] = None,
                line_channels: Optional[Sequence[ChannelLineLineChannelArgs]] = None,
                resource_group_name: Optional[str] = None,
                location: Optional[str] = None)
func NewChannelLine(ctx *Context, name string, args ChannelLineArgs, opts ...ResourceOption) (*ChannelLine, error)
public ChannelLine(string name, ChannelLineArgs args, CustomResourceOptions? opts = null)
public ChannelLine(String name, ChannelLineArgs args)
public ChannelLine(String name, ChannelLineArgs args, CustomResourceOptions options)
type: azure:bot:ChannelLine
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. ChannelLineArgs
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. ChannelLineArgs
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. ChannelLineArgs
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. ChannelLineArgs
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. ChannelLineArgs
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 channelLineResource = new Azure.Bot.ChannelLine("channelLineResource", new()
{
    BotName = "string",
    LineChannels = new[]
    {
        new Azure.Bot.Inputs.ChannelLineLineChannelArgs
        {
            AccessToken = "string",
            Secret = "string",
        },
    },
    ResourceGroupName = "string",
    Location = "string",
});
Copy
example, err := bot.NewChannelLine(ctx, "channelLineResource", &bot.ChannelLineArgs{
	BotName: pulumi.String("string"),
	LineChannels: bot.ChannelLineLineChannelArray{
		&bot.ChannelLineLineChannelArgs{
			AccessToken: pulumi.String("string"),
			Secret:      pulumi.String("string"),
		},
	},
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
})
Copy
var channelLineResource = new ChannelLine("channelLineResource", ChannelLineArgs.builder()
    .botName("string")
    .lineChannels(ChannelLineLineChannelArgs.builder()
        .accessToken("string")
        .secret("string")
        .build())
    .resourceGroupName("string")
    .location("string")
    .build());
Copy
channel_line_resource = azure.bot.ChannelLine("channelLineResource",
    bot_name="string",
    line_channels=[{
        "access_token": "string",
        "secret": "string",
    }],
    resource_group_name="string",
    location="string")
Copy
const channelLineResource = new azure.bot.ChannelLine("channelLineResource", {
    botName: "string",
    lineChannels: [{
        accessToken: "string",
        secret: "string",
    }],
    resourceGroupName: "string",
    location: "string",
});
Copy
type: azure:bot:ChannelLine
properties:
    botName: string
    lineChannels:
        - accessToken: string
          secret: string
    location: string
    resourceGroupName: string
Copy

ChannelLine 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 ChannelLine 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.
LineChannels This property is required. List<ChannelLineLineChannel>
One or more line_channel blocks as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the Line Channel should be created. 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.
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.
LineChannels This property is required. []ChannelLineLineChannelArgs
One or more line_channel blocks as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the Line Channel should be created. 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.
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.
lineChannels This property is required. List<ChannelLineLineChannel>
One or more line_channel blocks as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the Line Channel should be created. 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.
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.
lineChannels This property is required. ChannelLineLineChannel[]
One or more line_channel blocks as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the Line Channel should be created. 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.
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.
line_channels This property is required. Sequence[ChannelLineLineChannelArgs]
One or more line_channel blocks as defined below.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group where the Line Channel should be created. 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.
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.
lineChannels This property is required. List<Property Map>
One or more line_channel blocks as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the Line Channel should be created. 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the ChannelLine 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 ChannelLine Resource

Get an existing ChannelLine 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?: ChannelLineState, opts?: CustomResourceOptions): ChannelLine
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bot_name: Optional[str] = None,
        line_channels: Optional[Sequence[ChannelLineLineChannelArgs]] = None,
        location: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> ChannelLine
func GetChannelLine(ctx *Context, name string, id IDInput, state *ChannelLineState, opts ...ResourceOption) (*ChannelLine, error)
public static ChannelLine Get(string name, Input<string> id, ChannelLineState? state, CustomResourceOptions? opts = null)
public static ChannelLine get(String name, Output<String> id, ChannelLineState state, CustomResourceOptions options)
resources:  _:    type: azure:bot:ChannelLine    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.
LineChannels List<ChannelLineLineChannel>
One or more line_channel blocks as defined below.
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.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the Line Channel should be created. Changing this forces a new resource to be created.
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.
LineChannels []ChannelLineLineChannelArgs
One or more line_channel blocks as defined below.
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.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the Line Channel should be created. Changing this forces a new resource to be created.
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.
lineChannels List<ChannelLineLineChannel>
One or more line_channel blocks as defined below.
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.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group where the Line Channel should be created. Changing this forces a new resource to be created.
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.
lineChannels ChannelLineLineChannel[]
One or more line_channel blocks as defined below.
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.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group where the Line Channel should be created. Changing this forces a new resource to be created.
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.
line_channels Sequence[ChannelLineLineChannelArgs]
One or more line_channel blocks as defined below.
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.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group where the Line Channel should be created. Changing this forces a new resource to be created.
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.
lineChannels List<Property Map>
One or more line_channel blocks as defined below.
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.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group where the Line Channel should be created. Changing this forces a new resource to be created.

Supporting Types

ChannelLineLineChannel
, ChannelLineLineChannelArgs

AccessToken This property is required. string
The access token which is used to call the Line Channel API.
Secret This property is required. string
The secret which is used to access the Line Channel.
AccessToken This property is required. string
The access token which is used to call the Line Channel API.
Secret This property is required. string
The secret which is used to access the Line Channel.
accessToken This property is required. String
The access token which is used to call the Line Channel API.
secret This property is required. String
The secret which is used to access the Line Channel.
accessToken This property is required. string
The access token which is used to call the Line Channel API.
secret This property is required. string
The secret which is used to access the Line Channel.
access_token This property is required. str
The access token which is used to call the Line Channel API.
secret This property is required. str
The secret which is used to access the Line Channel.
accessToken This property is required. String
The access token which is used to call the Line Channel API.
secret This property is required. String
The secret which is used to access the Line Channel.

Import

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

$ pulumi import azure:bot/channelLine:ChannelLine example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.BotService/botServices/botService1/channels/LineChannel
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.