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

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.bot.ChannelSlack

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Slack integration for a Bot Channel

    Note A bot can only have a single Slack 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",
    location: "global",
    resourceGroupName: example.name,
    sku: "F0",
    microsoftAppId: current.then(current => current.clientId),
});
const exampleChannelSlack = new azure.bot.ChannelSlack("example", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: example.name,
    clientId: "exampleId",
    clientSecret: "exampleSecret",
    verificationToken: "exampleVerificationToken",
});

    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",
    location="global",
    resource_group_name=example.name,
    sku="F0",
    microsoft_app_id=current.client_id)
example_channel_slack = azure.bot.ChannelSlack("example",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example.name,
    client_id="exampleId",
    client_secret="exampleSecret",
    verification_token="exampleVerificationToken")

    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"),
			Location:          pulumi.String("global"),
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("F0"),
			MicrosoftAppId:    pulumi.String(current.ClientId),
		})
		if err != nil {
			return err
		}
		_, err = bot.NewChannelSlack(ctx, "example", &bot.ChannelSlackArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: example.Name,
			ClientId:          pulumi.String("exampleId"),
			ClientSecret:      pulumi.String("exampleSecret"),
			VerificationToken: pulumi.String("exampleVerificationToken"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        Location = "global",
        ResourceGroupName = example.Name,
        Sku = "F0",
        MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
    });

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

});

    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

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

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

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleChannelsRegistration:
    type: azure:bot:ChannelsRegistration
    name: example
    properties:
      name: example
      location: global
      resourceGroupName: ${example.name}
      sku: F0
      microsoftAppId: ${current.clientId}
  exampleChannelSlack:
    type: azure:bot:ChannelSlack
    name: example
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${example.name}
      clientId: exampleId
      clientSecret: exampleSecret
      verificationToken: exampleVerificationToken
variables:
  current:
    fn::invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

    Create ChannelSlack Resource

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

    Constructor syntax

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

@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,
                 resource_group_name: Optional[str] = None,
                 verification_token: Optional[str] = None,
                 landing_page_url: Optional[str] = None,
                 location: Optional[str] = None,
                 signing_secret: Optional[str] = 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.

    Parameters

    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.

    Constructor example

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

    var channelSlackResource = new Azure.Bot.ChannelSlack("channelSlackResource", new()
{
    BotName = "string",
    ClientId = "string",
    ClientSecret = "string",
    ResourceGroupName = "string",
    VerificationToken = "string",
    LandingPageUrl = "string",
    Location = "string",
    SigningSecret = "string",
});

    example, err := bot.NewChannelSlack(ctx, "channelSlackResource", &bot.ChannelSlackArgs{
	BotName:           pulumi.String("string"),
	ClientId:          pulumi.String("string"),
	ClientSecret:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	VerificationToken: pulumi.String("string"),
	LandingPageUrl:    pulumi.String("string"),
	Location:          pulumi.String("string"),
	SigningSecret:     pulumi.String("string"),
})

    var channelSlackResource = new ChannelSlack("channelSlackResource", ChannelSlackArgs.builder()
    .botName("string")
    .clientId("string")
    .clientSecret("string")
    .resourceGroupName("string")
    .verificationToken("string")
    .landingPageUrl("string")
    .location("string")
    .signingSecret("string")
    .build());

    channel_slack_resource = azure.bot.ChannelSlack("channelSlackResource",
    bot_name="string",
    client_id="string",
    client_secret="string",
    resource_group_name="string",
    verification_token="string",
    landing_page_url="string",
    location="string",
    signing_secret="string")

    const channelSlackResource = new azure.bot.ChannelSlack("channelSlackResource", {
    botName: "string",
    clientId: "string",
    clientSecret: "string",
    resourceGroupName: "string",
    verificationToken: "string",
    landingPageUrl: "string",
    location: "string",
    signingSecret: "string",
});

    type: azure:bot:ChannelSlack
properties:
    botName: string
    clientId: string
    clientSecret: string
    landingPageUrl: string
    location: string
    resourceGroupName: string
    signingSecret: string
    verificationToken: string

    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

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

    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

    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.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure