Azure Classic

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

ChannelAlexa

Manages an Alexa integration for a Bot Channel

Note A bot can only have a single Alexa 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 exampleChannelAlexa = new Azure.Bot.ChannelAlexa("exampleChannelAlexa", new Azure.Bot.ChannelAlexaArgs
        {
            BotName = exampleChannelsRegistration.Name,
            Location = exampleChannelsRegistration.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            SkillId = "amzn1.ask.skill.00000000-0000-0000-0000-000000000000",
        });
    }

}
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.NewChannelAlexa(ctx, "exampleChannelAlexa", &bot.ChannelAlexaArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SkillId:           pulumi.String("amzn1.ask.skill.00000000-0000-0000-0000-000000000000"),
		})
		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_alexa = azure.bot.ChannelAlexa("exampleChannelAlexa",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example_resource_group.name,
    skill_id="amzn1.ask.skill.00000000-0000-0000-0000-000000000000")
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 exampleChannelAlexa = new azure.bot.ChannelAlexa("exampleChannelAlexa", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: exampleResourceGroup.name,
    skillId: "amzn1.ask.skill.00000000-0000-0000-0000-000000000000",
});
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}
  exampleChannelAlexa:
    type: azure:bot:ChannelAlexa
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${exampleResourceGroup.name}
      skillId: amzn1.ask.skill.00000000-0000-0000-0000-000000000000
variables:
  current:
    Fn::Invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

Create a ChannelAlexa Resource

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

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

ChannelAlexa 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 ChannelAlexa 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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

SkillId string

The Alexa skill ID for the Alexa Channel.

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

SkillId string

The Alexa skill ID for the Alexa Channel.

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skillId String

The Alexa skill ID for the Alexa Channel.

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skillId string

The Alexa skill ID for the Alexa Channel.

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skill_id str

The Alexa skill ID for the Alexa Channel.

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skillId String

The Alexa skill ID for the Alexa Channel.

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 ChannelAlexa 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 ChannelAlexa Resource

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

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

SkillId string

The Alexa skill ID for the Alexa Channel.

BotName string

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

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

SkillId string

The Alexa skill ID for the Alexa Channel.

botName String

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

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skillId String

The Alexa skill ID for the Alexa Channel.

botName string

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

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skillId string

The Alexa skill ID for the Alexa Channel.

bot_name str

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

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skill_id str

The Alexa skill ID for the Alexa Channel.

botName String

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

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 where the Alexa Channel should be created. Changing this forces a new resource to be created.

skillId String

The Alexa skill ID for the Alexa Channel.

Import

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

 $ pulumi import azure:bot/channelAlexa:ChannelAlexa example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.BotService/botServices/botService1/channels/AlexaChannel

Package Details

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

This Pulumi package is based on the azurerm Terraform Provider.