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

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.bot.WebApp

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a Bot Web App.

    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 exampleWebApp = new azure.bot.WebApp("example", {
        name: "example",
        location: "global",
        resourceGroupName: example.name,
        sku: "F0",
        microsoftAppId: current.then(current => current.clientId),
    });
    
    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_web_app = azure.bot.WebApp("example",
        name="example",
        location="global",
        resource_group_name=example.name,
        sku="F0",
        microsoft_app_id=current.client_id)
    
    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
    		}
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = bot.NewWebApp(ctx, "example", &bot.WebAppArgs{
    			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
    		}
    		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 exampleWebApp = new Azure.Bot.WebApp("example", new()
        {
            Name = "example",
            Location = "global",
            ResourceGroupName = example.Name,
            Sku = "F0",
            MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
        });
    
    });
    
    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.WebApp;
    import com.pulumi.azure.bot.WebAppArgs;
    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 exampleWebApp = new WebApp("exampleWebApp", WebAppArgs.builder()        
                .name("example")
                .location("global")
                .resourceGroupName(example.name())
                .sku("F0")
                .microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleWebApp:
        type: azure:bot:WebApp
        name: example
        properties:
          name: example
          location: global
          resourceGroupName: ${example.name}
          sku: F0
          microsoftAppId: ${current.clientId}
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create WebApp Resource

    new WebApp(name: string, args: WebAppArgs, opts?: CustomResourceOptions);
    @overload
    def WebApp(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               developer_app_insights_api_key: Optional[str] = None,
               developer_app_insights_application_id: Optional[str] = None,
               developer_app_insights_key: Optional[str] = None,
               display_name: Optional[str] = None,
               endpoint: Optional[str] = None,
               location: Optional[str] = None,
               luis_app_ids: Optional[Sequence[str]] = None,
               luis_key: Optional[str] = None,
               microsoft_app_id: Optional[str] = None,
               name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               sku: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
    @overload
    def WebApp(resource_name: str,
               args: WebAppArgs,
               opts: Optional[ResourceOptions] = None)
    func NewWebApp(ctx *Context, name string, args WebAppArgs, opts ...ResourceOption) (*WebApp, error)
    public WebApp(string name, WebAppArgs args, CustomResourceOptions? opts = null)
    public WebApp(String name, WebAppArgs args)
    public WebApp(String name, WebAppArgs args, CustomResourceOptions options)
    
    type: azure:bot:WebApp
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args WebAppArgs
    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 WebAppArgs
    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 WebAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebAppArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    WebApp 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 WebApp resource accepts the following input properties:

    MicrosoftAppId string
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with the Web App Bot.
    DeveloperAppInsightsApplicationId string
    The Application Insights Application ID to associate with the Web App Bot.
    DeveloperAppInsightsKey string
    The Application Insights Key to associate with the Web App Bot.
    DisplayName string
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    Endpoint string
    The Web App Bot endpoint.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    LuisAppIds List<string>
    A list of LUIS App IDs to associate with the Web App Bot.
    LuisKey string
    The LUIS key to associate with the Web App Bot.
    Name string
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    MicrosoftAppId string
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with the Web App Bot.
    DeveloperAppInsightsApplicationId string
    The Application Insights Application ID to associate with the Web App Bot.
    DeveloperAppInsightsKey string
    The Application Insights Key to associate with the Web App Bot.
    DisplayName string
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    Endpoint string
    The Web App Bot endpoint.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    LuisAppIds []string
    A list of LUIS App IDs to associate with the Web App Bot.
    LuisKey string
    The LUIS key to associate with the Web App Bot.
    Name string
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    microsoftAppId String
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku String
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    developerAppInsightsApiKey String
    The Application Insights API Key to associate with the Web App Bot.
    developerAppInsightsApplicationId String
    The Application Insights Application ID to associate with the Web App Bot.
    developerAppInsightsKey String
    The Application Insights Key to associate with the Web App Bot.
    displayName String
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint String
    The Web App Bot endpoint.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with the Web App Bot.
    luisKey String
    The LUIS key to associate with the Web App Bot.
    name String
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    microsoftAppId string
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku string
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    developerAppInsightsApiKey string
    The Application Insights API Key to associate with the Web App Bot.
    developerAppInsightsApplicationId string
    The Application Insights Application ID to associate with the Web App Bot.
    developerAppInsightsKey string
    The Application Insights Key to associate with the Web App Bot.
    displayName string
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint string
    The Web App Bot endpoint.
    location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luisAppIds string[]
    A list of LUIS App IDs to associate with the Web App Bot.
    luisKey string
    The LUIS key to associate with the Web App Bot.
    name string
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    microsoft_app_id str
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku str
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    developer_app_insights_api_key str
    The Application Insights API Key to associate with the Web App Bot.
    developer_app_insights_application_id str
    The Application Insights Application ID to associate with the Web App Bot.
    developer_app_insights_key str
    The Application Insights Key to associate with the Web App Bot.
    display_name str
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint str
    The Web App Bot endpoint.
    location str
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luis_app_ids Sequence[str]
    A list of LUIS App IDs to associate with the Web App Bot.
    luis_key str
    The LUIS key to associate with the Web App Bot.
    name str
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    microsoftAppId String
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku String
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    developerAppInsightsApiKey String
    The Application Insights API Key to associate with the Web App Bot.
    developerAppInsightsApplicationId String
    The Application Insights Application ID to associate with the Web App Bot.
    developerAppInsightsKey String
    The Application Insights Key to associate with the Web App Bot.
    displayName String
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint String
    The Web App Bot endpoint.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with the Web App Bot.
    luisKey String
    The LUIS key to associate with the Web App Bot.
    name String
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Get an existing WebApp 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?: WebAppState, opts?: CustomResourceOptions): WebApp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            developer_app_insights_api_key: Optional[str] = None,
            developer_app_insights_application_id: Optional[str] = None,
            developer_app_insights_key: Optional[str] = None,
            display_name: Optional[str] = None,
            endpoint: Optional[str] = None,
            location: Optional[str] = None,
            luis_app_ids: Optional[Sequence[str]] = None,
            luis_key: Optional[str] = None,
            microsoft_app_id: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            sku: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> WebApp
    func GetWebApp(ctx *Context, name string, id IDInput, state *WebAppState, opts ...ResourceOption) (*WebApp, error)
    public static WebApp Get(string name, Input<string> id, WebAppState? state, CustomResourceOptions? opts = null)
    public static WebApp get(String name, Output<String> id, WebAppState 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:
    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with the Web App Bot.
    DeveloperAppInsightsApplicationId string
    The Application Insights Application ID to associate with the Web App Bot.
    DeveloperAppInsightsKey string
    The Application Insights Key to associate with the Web App Bot.
    DisplayName string
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    Endpoint string
    The Web App Bot endpoint.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    LuisAppIds List<string>
    A list of LUIS App IDs to associate with the Web App Bot.
    LuisKey string
    The LUIS key to associate with the Web App Bot.
    MicrosoftAppId string
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    ResourceGroupName string
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with the Web App Bot.
    DeveloperAppInsightsApplicationId string
    The Application Insights Application ID to associate with the Web App Bot.
    DeveloperAppInsightsKey string
    The Application Insights Key to associate with the Web App Bot.
    DisplayName string
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    Endpoint string
    The Web App Bot endpoint.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    LuisAppIds []string
    A list of LUIS App IDs to associate with the Web App Bot.
    LuisKey string
    The LUIS key to associate with the Web App Bot.
    MicrosoftAppId string
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    ResourceGroupName string
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    developerAppInsightsApiKey String
    The Application Insights API Key to associate with the Web App Bot.
    developerAppInsightsApplicationId String
    The Application Insights Application ID to associate with the Web App Bot.
    developerAppInsightsKey String
    The Application Insights Key to associate with the Web App Bot.
    displayName String
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint String
    The Web App Bot endpoint.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with the Web App Bot.
    luisKey String
    The LUIS key to associate with the Web App Bot.
    microsoftAppId String
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    resourceGroupName String
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku String
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    developerAppInsightsApiKey string
    The Application Insights API Key to associate with the Web App Bot.
    developerAppInsightsApplicationId string
    The Application Insights Application ID to associate with the Web App Bot.
    developerAppInsightsKey string
    The Application Insights Key to associate with the Web App Bot.
    displayName string
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint string
    The Web App Bot endpoint.
    location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luisAppIds string[]
    A list of LUIS App IDs to associate with the Web App Bot.
    luisKey string
    The LUIS key to associate with the Web App Bot.
    microsoftAppId string
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    resourceGroupName string
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku string
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    developer_app_insights_api_key str
    The Application Insights API Key to associate with the Web App Bot.
    developer_app_insights_application_id str
    The Application Insights Application ID to associate with the Web App Bot.
    developer_app_insights_key str
    The Application Insights Key to associate with the Web App Bot.
    display_name str
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint str
    The Web App Bot endpoint.
    location str
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luis_app_ids Sequence[str]
    A list of LUIS App IDs to associate with the Web App Bot.
    luis_key str
    The LUIS key to associate with the Web App Bot.
    microsoft_app_id str
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    resource_group_name str
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku str
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    developerAppInsightsApiKey String
    The Application Insights API Key to associate with the Web App Bot.
    developerAppInsightsApplicationId String
    The Application Insights Application ID to associate with the Web App Bot.
    developerAppInsightsKey String
    The Application Insights Key to associate with the Web App Bot.
    displayName String
    The name of the Web App Bot will be displayed as. This defaults to name if not specified.
    endpoint String
    The Web App Bot endpoint.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with the Web App Bot.
    luisKey String
    The LUIS key to associate with the Web App Bot.
    microsoftAppId String
    The Microsoft Application ID for the Web App Bot. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Web App Bot. Changing this forces a new resource to be created. Must be globally unique.
    resourceGroupName String
    The name of the resource group in which to create the Web App Bot. Changing this forces a new resource to be created.
    sku String
    The SKU of the Web App Bot. Valid values include F0 or S1. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Import

    Bot Web App’s can be imported using the resource id, e.g.

    $ pulumi import azure:bot/webApp:WebApp example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example
    

    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 Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi