Azure Classic

v5.25.0 published on Thursday, Nov 24, 2022 by Pulumi

ChannelSlack

Manages a Slack integration for a Bot Channel

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

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

    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

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

    var exampleChannelSlack = new Azure.Bot.ChannelSlack("exampleChannelSlack", new()
    {
        BotName = exampleChannelsRegistration.Name,
        Location = exampleChannelsRegistration.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        ClientId = "exampleId",
        ClientSecret = "exampleSecret",
        VerificationToken = "exampleVerificationToken",
    });

});
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.NewChannelSlack(ctx, "exampleChannelSlack", &bot.ChannelSlackArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			ClientId:          pulumi.String("exampleId"),
			ClientSecret:      pulumi.String("exampleSecret"),
			VerificationToken: pulumi.String("exampleVerificationToken"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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.ChannelSlack;
import com.pulumi.azure.bot.ChannelSlackArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

        var exampleChannelSlack = new ChannelSlack("exampleChannelSlack", ChannelSlackArgs.builder()        
            .botName(exampleChannelsRegistration.name())
            .location(exampleChannelsRegistration.location())
            .resourceGroupName(exampleResourceGroup.name())
            .clientId("exampleId")
            .clientSecret("exampleSecret")
            .verificationToken("exampleVerificationToken")
            .build());

    }
}
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_slack = azure.bot.ChannelSlack("exampleChannelSlack",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example_resource_group.name,
    client_id="exampleId",
    client_secret="exampleSecret",
    verification_token="exampleVerificationToken")
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 exampleChannelSlack = new azure.bot.ChannelSlack("exampleChannelSlack", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: exampleResourceGroup.name,
    clientId: "exampleId",
    clientSecret: "exampleSecret",
    verificationToken: "exampleVerificationToken",
});
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}
  exampleChannelSlack:
    type: azure:bot:ChannelSlack
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${exampleResourceGroup.name}
      clientId: exampleId
      clientSecret: exampleSecret
      verificationToken: exampleVerificationToken
variables:
  current:
    Fn::Invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

Create ChannelSlack Resource

new ChannelSlack(name: string, args: ChannelSlackArgs, opts?: CustomResourceOptions);
@overload
def ChannelSlack(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bot_name: Optional[str] = None,
                 client_id: Optional[str] = None,
                 client_secret: Optional[str] = None,
                 landing_page_url: Optional[str] = None,
                 location: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 signing_secret: Optional[str] = None,
                 verification_token: Optional[str] = None)
@overload
def ChannelSlack(resource_name: str,
                 args: ChannelSlackArgs,
                 opts: Optional[ResourceOptions] = None)
func NewChannelSlack(ctx *Context, name string, args ChannelSlackArgs, opts ...ResourceOption) (*ChannelSlack, error)
public ChannelSlack(string name, ChannelSlackArgs args, CustomResourceOptions? opts = null)
public ChannelSlack(String name, ChannelSlackArgs args)
public ChannelSlack(String name, ChannelSlackArgs args, CustomResourceOptions options)
type: azure:bot:ChannelSlack
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ChannelSlackArgs
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 ChannelSlackArgs
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 ChannelSlackArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ChannelSlackArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ChannelSlackArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ChannelSlack 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 ChannelSlack 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.

ClientId string

The Client ID that will be used to authenticate with Slack.

ClientSecret string

The Client Secret that will be used to authenticate with Slack.

ResourceGroupName string

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

VerificationToken string

The Verification Token that will be used to authenticate with Slack.

LandingPageUrl string

The Slack Landing Page URL.

Location string

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

SigningSecret string

The Signing Secret that will be used to sign the requests.

BotName string

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

ClientId string

The Client ID that will be used to authenticate with Slack.

ClientSecret string

The Client Secret that will be used to authenticate with Slack.

ResourceGroupName string

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

VerificationToken string

The Verification Token that will be used to authenticate with Slack.

LandingPageUrl string

The Slack Landing Page URL.

Location string

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

SigningSecret string

The Signing Secret that will be used to sign the requests.

botName String

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

clientId String

The Client ID that will be used to authenticate with Slack.

clientSecret String

The Client Secret that will be used to authenticate with Slack.

resourceGroupName String

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

verificationToken String

The Verification Token that will be used to authenticate with Slack.

landingPageUrl String

The Slack Landing Page URL.

location String

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

signingSecret String

The Signing Secret that will be used to sign the requests.

botName string

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

clientId string

The Client ID that will be used to authenticate with Slack.

clientSecret string

The Client Secret that will be used to authenticate with Slack.

resourceGroupName string

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

verificationToken string

The Verification Token that will be used to authenticate with Slack.

landingPageUrl string

The Slack Landing Page URL.

location string

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

signingSecret string

The Signing Secret that will be used to sign the requests.

bot_name str

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

client_id str

The Client ID that will be used to authenticate with Slack.

client_secret str

The Client Secret that will be used to authenticate with Slack.

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.

verification_token str

The Verification Token that will be used to authenticate with Slack.

landing_page_url str

The Slack Landing Page URL.

location str

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

signing_secret str

The Signing Secret that will be used to sign the requests.

botName String

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

clientId String

The Client ID that will be used to authenticate with Slack.

clientSecret String

The Client Secret that will be used to authenticate with Slack.

resourceGroupName String

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

verificationToken String

The Verification Token that will be used to authenticate with Slack.

landingPageUrl String

The Slack Landing Page URL.

location String

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

signingSecret String

The Signing Secret that will be used to sign the requests.

Outputs

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

Get an existing ChannelSlack 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?: ChannelSlackState, opts?: CustomResourceOptions): ChannelSlack
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bot_name: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        landing_page_url: Optional[str] = None,
        location: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        signing_secret: Optional[str] = None,
        verification_token: Optional[str] = None) -> ChannelSlack
func GetChannelSlack(ctx *Context, name string, id IDInput, state *ChannelSlackState, opts ...ResourceOption) (*ChannelSlack, error)
public static ChannelSlack Get(string name, Input<string> id, ChannelSlackState? state, CustomResourceOptions? opts = null)
public static ChannelSlack get(String name, Output<String> id, ChannelSlackState 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.

ClientId string

The Client ID that will be used to authenticate with Slack.

ClientSecret string

The Client Secret that will be used to authenticate with Slack.

LandingPageUrl string

The Slack Landing Page URL.

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.

SigningSecret string

The Signing Secret that will be used to sign the requests.

VerificationToken string

The Verification Token that will be used to authenticate with Slack.

BotName string

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

ClientId string

The Client ID that will be used to authenticate with Slack.

ClientSecret string

The Client Secret that will be used to authenticate with Slack.

LandingPageUrl string

The Slack Landing Page URL.

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.

SigningSecret string

The Signing Secret that will be used to sign the requests.

VerificationToken string

The Verification Token that will be used to authenticate with Slack.

botName String

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

clientId String

The Client ID that will be used to authenticate with Slack.

clientSecret String

The Client Secret that will be used to authenticate with Slack.

landingPageUrl String

The Slack Landing Page URL.

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.

signingSecret String

The Signing Secret that will be used to sign the requests.

verificationToken String

The Verification Token that will be used to authenticate with Slack.

botName string

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

clientId string

The Client ID that will be used to authenticate with Slack.

clientSecret string

The Client Secret that will be used to authenticate with Slack.

landingPageUrl string

The Slack Landing Page URL.

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.

signingSecret string

The Signing Secret that will be used to sign the requests.

verificationToken string

The Verification Token that will be used to authenticate with Slack.

bot_name str

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

client_id str

The Client ID that will be used to authenticate with Slack.

client_secret str

The Client Secret that will be used to authenticate with Slack.

landing_page_url str

The Slack Landing Page URL.

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.

signing_secret str

The Signing Secret that will be used to sign the requests.

verification_token str

The Verification Token that will be used to authenticate with Slack.

botName String

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

clientId String

The Client ID that will be used to authenticate with Slack.

clientSecret String

The Client Secret that will be used to authenticate with Slack.

landingPageUrl String

The Slack Landing Page URL.

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.

signingSecret String

The Signing Secret that will be used to sign the requests.

verificationToken String

The Verification Token that will be used to authenticate with Slack.

Import

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

 $ pulumi import azure:bot/channelSlack:ChannelSlack example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example/channels/SlackChannel

Package Details

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

This Pulumi package is based on the azurerm Terraform Provider.