Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

ChannelTeams

Manages a MS Teams integration for a Bot Channel

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleChannelsRegistration = new Azure.Bot.ChannelsRegistration("exampleChannelsRegistration", new Azure.Bot.ChannelsRegistrationArgs
        {
            Location = "global",
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "F0",
            MicrosoftAppId = current.Apply(current => current.ClientId),
        });
        var exampleChannelTeams = new Azure.Bot.ChannelTeams("exampleChannelTeams", new Azure.Bot.ChannelTeamsArgs
        {
            BotName = exampleChannelsRegistration.Name,
            Location = exampleChannelsRegistration.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/bot"
	"github.com/pulumi/pulumi-azure/sdk/v5/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, nil, nil)
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleChannelsRegistration, err := bot.NewChannelsRegistration(ctx, "exampleChannelsRegistration", &bot.ChannelsRegistrationArgs{
			Location:          pulumi.String("global"),
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("F0"),
			MicrosoftAppId:    pulumi.String(current.ClientId),
		})
		if err != nil {
			return err
		}
		_, err = bot.NewChannelTeams(ctx, "exampleChannelTeams", &bot.ChannelTeamsArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_channels_registration = azure.bot.ChannelsRegistration("exampleChannelsRegistration",
    location="global",
    resource_group_name=example_resource_group.name,
    sku="F0",
    microsoft_app_id=current.client_id)
example_channel_teams = azure.bot.ChannelTeams("exampleChannelTeams",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example_resource_group.name)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleChannelsRegistration = new azure.bot.ChannelsRegistration("exampleChannelsRegistration", {
    location: "global",
    resourceGroupName: exampleResourceGroup.name,
    sku: "F0",
    microsoftAppId: current.then(current => current.clientId),
});
const exampleChannelTeams = new azure.bot.ChannelTeams("exampleChannelTeams", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: exampleResourceGroup.name,
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleChannelsRegistration:
    type: azure:bot:ChannelsRegistration
    properties:
      location: global
      resourceGroupName: ${exampleResourceGroup.name}
      sku: F0
      microsoftAppId: ${current.clientId}
  exampleChannelTeams:
    type: azure:bot:ChannelTeams
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${exampleResourceGroup.name}
variables:
  current:
    Fn::Invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

Create a ChannelTeams Resource

new ChannelTeams(name: string, args: ChannelTeamsArgs, opts?: CustomResourceOptions);
@overload
def ChannelTeams(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bot_name: Optional[str] = None,
                 calling_web_hook: Optional[str] = None,
                 enable_calling: Optional[bool] = None,
                 location: Optional[str] = None,
                 resource_group_name: Optional[str] = None)
@overload
def ChannelTeams(resource_name: str,
                 args: ChannelTeamsArgs,
                 opts: Optional[ResourceOptions] = None)
func NewChannelTeams(ctx *Context, name string, args ChannelTeamsArgs, opts ...ResourceOption) (*ChannelTeams, error)
public ChannelTeams(string name, ChannelTeamsArgs args, CustomResourceOptions? opts = null)
public ChannelTeams(String name, ChannelTeamsArgs args)
public ChannelTeams(String name, ChannelTeamsArgs args, CustomResourceOptions options)
type: azure:bot:ChannelTeams
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

ChannelTeams Resource Properties

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

Inputs

The ChannelTeams resource accepts the following input properties:

BotName string

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

CallingWebHook string

Specifies the webhook for Microsoft Teams channel calls.

EnableCalling bool

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

Location string

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

BotName string

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

CallingWebHook string

Specifies the webhook for Microsoft Teams channel calls.

EnableCalling bool

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

Location string

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

botName String

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

callingWebHook String

Specifies the webhook for Microsoft Teams channel calls.

enableCalling Boolean

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location String

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

botName string

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

callingWebHook string

Specifies the webhook for Microsoft Teams channel calls.

enableCalling boolean

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location string

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

bot_name str

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

calling_web_hook str

Specifies the webhook for Microsoft Teams channel calls.

enable_calling bool

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location str

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

botName String

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

callingWebHook String

Specifies the webhook for Microsoft Teams channel calls.

enableCalling Boolean

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location String

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 ChannelTeams 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 an Existing ChannelTeams Resource

Get an existing ChannelTeams 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?: ChannelTeamsState, opts?: CustomResourceOptions): ChannelTeams
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bot_name: Optional[str] = None,
        calling_web_hook: Optional[str] = None,
        enable_calling: Optional[bool] = None,
        location: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> ChannelTeams
func GetChannelTeams(ctx *Context, name string, id IDInput, state *ChannelTeamsState, opts ...ResourceOption) (*ChannelTeams, error)
public static ChannelTeams Get(string name, Input<string> id, ChannelTeamsState? state, CustomResourceOptions? opts = null)
public static ChannelTeams get(String name, Output<String> id, ChannelTeamsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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 string

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

CallingWebHook string

Specifies the webhook for Microsoft Teams channel calls.

EnableCalling bool

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

Location string

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

BotName string

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

CallingWebHook string

Specifies the webhook for Microsoft Teams channel calls.

EnableCalling bool

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

Location string

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

botName String

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

callingWebHook String

Specifies the webhook for Microsoft Teams channel calls.

enableCalling Boolean

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location String

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

botName string

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

callingWebHook string

Specifies the webhook for Microsoft Teams channel calls.

enableCalling boolean

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location string

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

bot_name str

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

calling_web_hook str

Specifies the webhook for Microsoft Teams channel calls.

enable_calling bool

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location str

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

botName String

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

callingWebHook String

Specifies the webhook for Microsoft Teams channel calls.

enableCalling Boolean

Specifies whether to enable Microsoft Teams channel calls. This defaults to false.

location String

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

Import

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

 $ pulumi import azure:bot/channelTeams:ChannelTeams example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example/channels/MsTeamsChannel

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.