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

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.bot.ServiceAzureBot

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    Manages an Azure Bot Service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleInsights = new azure.appinsights.Insights("example", {
        name: "example-appinsights",
        location: example.location,
        resourceGroupName: example.name,
        applicationType: "web",
    });
    const exampleApiKey = new azure.appinsights.ApiKey("example", {
        name: "example-appinsightsapikey",
        applicationInsightsId: exampleInsights.id,
        readPermissions: [
            "aggregate",
            "api",
            "draft",
            "extendqueries",
            "search",
        ],
    });
    const current = azure.core.getClientConfig({});
    const exampleServiceAzureBot = new azure.bot.ServiceAzureBot("example", {
        name: "exampleazurebot",
        resourceGroupName: example.name,
        location: "global",
        microsoftAppId: current.then(current => current.clientId),
        sku: "F0",
        endpoint: "https://example.com",
        developerAppInsightsApiKey: exampleApiKey.apiKey,
        developerAppInsightsApplicationId: exampleInsights.appId,
        tags: {
            environment: "test",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_insights = azure.appinsights.Insights("example",
        name="example-appinsights",
        location=example.location,
        resource_group_name=example.name,
        application_type="web")
    example_api_key = azure.appinsights.ApiKey("example",
        name="example-appinsightsapikey",
        application_insights_id=example_insights.id,
        read_permissions=[
            "aggregate",
            "api",
            "draft",
            "extendqueries",
            "search",
        ])
    current = azure.core.get_client_config()
    example_service_azure_bot = azure.bot.ServiceAzureBot("example",
        name="exampleazurebot",
        resource_group_name=example.name,
        location="global",
        microsoft_app_id=current.client_id,
        sku="F0",
        endpoint="https://example.com",
        developer_app_insights_api_key=example_api_key.api_key,
        developer_app_insights_application_id=example_insights.app_id,
        tags={
            "environment": "test",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appinsights"
    	"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 {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleInsights, err := appinsights.NewInsights(ctx, "example", &appinsights.InsightsArgs{
    			Name:              pulumi.String("example-appinsights"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			ApplicationType:   pulumi.String("web"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleApiKey, err := appinsights.NewApiKey(ctx, "example", &appinsights.ApiKeyArgs{
    			Name:                  pulumi.String("example-appinsightsapikey"),
    			ApplicationInsightsId: exampleInsights.ID(),
    			ReadPermissions: pulumi.StringArray{
    				pulumi.String("aggregate"),
    				pulumi.String("api"),
    				pulumi.String("draft"),
    				pulumi.String("extendqueries"),
    				pulumi.String("search"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		current, err := core.GetClientConfig(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		_, err = bot.NewServiceAzureBot(ctx, "example", &bot.ServiceAzureBotArgs{
    			Name:                              pulumi.String("exampleazurebot"),
    			ResourceGroupName:                 example.Name,
    			Location:                          pulumi.String("global"),
    			MicrosoftAppId:                    pulumi.String(current.ClientId),
    			Sku:                               pulumi.String("F0"),
    			Endpoint:                          pulumi.String("https://example.com"),
    			DeveloperAppInsightsApiKey:        exampleApiKey.ApiKey,
    			DeveloperAppInsightsApplicationId: exampleInsights.AppId,
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("test"),
    			},
    		})
    		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 example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleInsights = new Azure.AppInsights.Insights("example", new()
        {
            Name = "example-appinsights",
            Location = example.Location,
            ResourceGroupName = example.Name,
            ApplicationType = "web",
        });
    
        var exampleApiKey = new Azure.AppInsights.ApiKey("example", new()
        {
            Name = "example-appinsightsapikey",
            ApplicationInsightsId = exampleInsights.Id,
            ReadPermissions = new[]
            {
                "aggregate",
                "api",
                "draft",
                "extendqueries",
                "search",
            },
        });
    
        var current = Azure.Core.GetClientConfig.Invoke();
    
        var exampleServiceAzureBot = new Azure.Bot.ServiceAzureBot("example", new()
        {
            Name = "exampleazurebot",
            ResourceGroupName = example.Name,
            Location = "global",
            MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
            Sku = "F0",
            Endpoint = "https://example.com",
            DeveloperAppInsightsApiKey = exampleApiKey.ApiKey,
            DeveloperAppInsightsApplicationId = exampleInsights.AppId,
            Tags = 
            {
                { "environment", "test" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.appinsights.Insights;
    import com.pulumi.azure.appinsights.InsightsArgs;
    import com.pulumi.azure.appinsights.ApiKey;
    import com.pulumi.azure.appinsights.ApiKeyArgs;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.bot.ServiceAzureBot;
    import com.pulumi.azure.bot.ServiceAzureBotArgs;
    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) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleInsights = new Insights("exampleInsights", InsightsArgs.builder()
                .name("example-appinsights")
                .location(example.location())
                .resourceGroupName(example.name())
                .applicationType("web")
                .build());
    
            var exampleApiKey = new ApiKey("exampleApiKey", ApiKeyArgs.builder()
                .name("example-appinsightsapikey")
                .applicationInsightsId(exampleInsights.id())
                .readPermissions(            
                    "aggregate",
                    "api",
                    "draft",
                    "extendqueries",
                    "search")
                .build());
    
            final var current = CoreFunctions.getClientConfig();
    
            var exampleServiceAzureBot = new ServiceAzureBot("exampleServiceAzureBot", ServiceAzureBotArgs.builder()
                .name("exampleazurebot")
                .resourceGroupName(example.name())
                .location("global")
                .microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
                .sku("F0")
                .endpoint("https://example.com")
                .developerAppInsightsApiKey(exampleApiKey.apiKey())
                .developerAppInsightsApplicationId(exampleInsights.appId())
                .tags(Map.of("environment", "test"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleInsights:
        type: azure:appinsights:Insights
        name: example
        properties:
          name: example-appinsights
          location: ${example.location}
          resourceGroupName: ${example.name}
          applicationType: web
      exampleApiKey:
        type: azure:appinsights:ApiKey
        name: example
        properties:
          name: example-appinsightsapikey
          applicationInsightsId: ${exampleInsights.id}
          readPermissions:
            - aggregate
            - api
            - draft
            - extendqueries
            - search
      exampleServiceAzureBot:
        type: azure:bot:ServiceAzureBot
        name: example
        properties:
          name: exampleazurebot
          resourceGroupName: ${example.name}
          location: global
          microsoftAppId: ${current.clientId}
          sku: F0
          endpoint: https://example.com
          developerAppInsightsApiKey: ${exampleApiKey.apiKey}
          developerAppInsightsApplicationId: ${exampleInsights.appId}
          tags:
            environment: test
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create ServiceAzureBot Resource

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

    Constructor syntax

    new ServiceAzureBot(name: string, args: ServiceAzureBotArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceAzureBot(resource_name: str,
                        args: ServiceAzureBotArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceAzureBot(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        microsoft_app_id: Optional[str] = None,
                        sku: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        luis_key: Optional[str] = None,
                        microsoft_app_msi_id: Optional[str] = None,
                        endpoint: Optional[str] = None,
                        icon_url: Optional[str] = None,
                        local_authentication_enabled: Optional[bool] = None,
                        location: Optional[str] = None,
                        luis_app_ids: Optional[Sequence[str]] = None,
                        cmk_key_vault_key_url: Optional[str] = None,
                        developer_app_insights_key: Optional[str] = None,
                        display_name: Optional[str] = None,
                        microsoft_app_tenant_id: Optional[str] = None,
                        microsoft_app_type: Optional[str] = None,
                        name: Optional[str] = None,
                        public_network_access_enabled: Optional[bool] = None,
                        developer_app_insights_application_id: Optional[str] = None,
                        developer_app_insights_api_key: Optional[str] = None,
                        streaming_endpoint_enabled: Optional[bool] = None,
                        tags: Optional[Mapping[str, str]] = None)
    func NewServiceAzureBot(ctx *Context, name string, args ServiceAzureBotArgs, opts ...ResourceOption) (*ServiceAzureBot, error)
    public ServiceAzureBot(string name, ServiceAzureBotArgs args, CustomResourceOptions? opts = null)
    public ServiceAzureBot(String name, ServiceAzureBotArgs args)
    public ServiceAzureBot(String name, ServiceAzureBotArgs args, CustomResourceOptions options)
    
    type: azure:bot:ServiceAzureBot
    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 ServiceAzureBotArgs
    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 ServiceAzureBotArgs
    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 ServiceAzureBotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceAzureBotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceAzureBotArgs
    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 serviceAzureBotResource = new Azure.Bot.ServiceAzureBot("serviceAzureBotResource", new()
    {
        MicrosoftAppId = "string",
        Sku = "string",
        ResourceGroupName = "string",
        LuisKey = "string",
        MicrosoftAppMsiId = "string",
        Endpoint = "string",
        IconUrl = "string",
        LocalAuthenticationEnabled = false,
        Location = "string",
        LuisAppIds = new[]
        {
            "string",
        },
        CmkKeyVaultKeyUrl = "string",
        DeveloperAppInsightsKey = "string",
        DisplayName = "string",
        MicrosoftAppTenantId = "string",
        MicrosoftAppType = "string",
        Name = "string",
        PublicNetworkAccessEnabled = false,
        DeveloperAppInsightsApplicationId = "string",
        DeveloperAppInsightsApiKey = "string",
        StreamingEndpointEnabled = false,
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := bot.NewServiceAzureBot(ctx, "serviceAzureBotResource", &bot.ServiceAzureBotArgs{
    	MicrosoftAppId:             pulumi.String("string"),
    	Sku:                        pulumi.String("string"),
    	ResourceGroupName:          pulumi.String("string"),
    	LuisKey:                    pulumi.String("string"),
    	MicrosoftAppMsiId:          pulumi.String("string"),
    	Endpoint:                   pulumi.String("string"),
    	IconUrl:                    pulumi.String("string"),
    	LocalAuthenticationEnabled: pulumi.Bool(false),
    	Location:                   pulumi.String("string"),
    	LuisAppIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	CmkKeyVaultKeyUrl:                 pulumi.String("string"),
    	DeveloperAppInsightsKey:           pulumi.String("string"),
    	DisplayName:                       pulumi.String("string"),
    	MicrosoftAppTenantId:              pulumi.String("string"),
    	MicrosoftAppType:                  pulumi.String("string"),
    	Name:                              pulumi.String("string"),
    	PublicNetworkAccessEnabled:        pulumi.Bool(false),
    	DeveloperAppInsightsApplicationId: pulumi.String("string"),
    	DeveloperAppInsightsApiKey:        pulumi.String("string"),
    	StreamingEndpointEnabled:          pulumi.Bool(false),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var serviceAzureBotResource = new ServiceAzureBot("serviceAzureBotResource", ServiceAzureBotArgs.builder()
        .microsoftAppId("string")
        .sku("string")
        .resourceGroupName("string")
        .luisKey("string")
        .microsoftAppMsiId("string")
        .endpoint("string")
        .iconUrl("string")
        .localAuthenticationEnabled(false)
        .location("string")
        .luisAppIds("string")
        .cmkKeyVaultKeyUrl("string")
        .developerAppInsightsKey("string")
        .displayName("string")
        .microsoftAppTenantId("string")
        .microsoftAppType("string")
        .name("string")
        .publicNetworkAccessEnabled(false)
        .developerAppInsightsApplicationId("string")
        .developerAppInsightsApiKey("string")
        .streamingEndpointEnabled(false)
        .tags(Map.of("string", "string"))
        .build());
    
    service_azure_bot_resource = azure.bot.ServiceAzureBot("serviceAzureBotResource",
        microsoft_app_id="string",
        sku="string",
        resource_group_name="string",
        luis_key="string",
        microsoft_app_msi_id="string",
        endpoint="string",
        icon_url="string",
        local_authentication_enabled=False,
        location="string",
        luis_app_ids=["string"],
        cmk_key_vault_key_url="string",
        developer_app_insights_key="string",
        display_name="string",
        microsoft_app_tenant_id="string",
        microsoft_app_type="string",
        name="string",
        public_network_access_enabled=False,
        developer_app_insights_application_id="string",
        developer_app_insights_api_key="string",
        streaming_endpoint_enabled=False,
        tags={
            "string": "string",
        })
    
    const serviceAzureBotResource = new azure.bot.ServiceAzureBot("serviceAzureBotResource", {
        microsoftAppId: "string",
        sku: "string",
        resourceGroupName: "string",
        luisKey: "string",
        microsoftAppMsiId: "string",
        endpoint: "string",
        iconUrl: "string",
        localAuthenticationEnabled: false,
        location: "string",
        luisAppIds: ["string"],
        cmkKeyVaultKeyUrl: "string",
        developerAppInsightsKey: "string",
        displayName: "string",
        microsoftAppTenantId: "string",
        microsoftAppType: "string",
        name: "string",
        publicNetworkAccessEnabled: false,
        developerAppInsightsApplicationId: "string",
        developerAppInsightsApiKey: "string",
        streamingEndpointEnabled: false,
        tags: {
            string: "string",
        },
    });
    
    type: azure:bot:ServiceAzureBot
    properties:
        cmkKeyVaultKeyUrl: string
        developerAppInsightsApiKey: string
        developerAppInsightsApplicationId: string
        developerAppInsightsKey: string
        displayName: string
        endpoint: string
        iconUrl: string
        localAuthenticationEnabled: false
        location: string
        luisAppIds:
            - string
        luisKey: string
        microsoftAppId: string
        microsoftAppMsiId: string
        microsoftAppTenantId: string
        microsoftAppType: string
        name: string
        publicNetworkAccessEnabled: false
        resourceGroupName: string
        sku: string
        streamingEndpointEnabled: false
        tags:
            string: string
    

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

    MicrosoftAppId string
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    CmkKeyVaultKeyUrl string

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with this Azure Bot Service.
    DeveloperAppInsightsApplicationId string
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    DeveloperAppInsightsKey string
    The Application Insight Key to associate with this Azure Bot Service.
    DisplayName string
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    Endpoint string
    The Azure Bot Service endpoint.
    IconUrl string
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    LocalAuthenticationEnabled bool
    Is local authentication enabled? Defaults to true.
    Location string
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    LuisAppIds List<string>
    A list of LUIS App IDs to associate with this Azure Bot Service.
    LuisKey string
    The LUIS key to associate with this Azure Bot Service.
    MicrosoftAppMsiId string
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppTenantId string
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppType string
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether public network access is enabled. Defaults to true.
    StreamingEndpointEnabled bool
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to this Azure Bot Service.
    MicrosoftAppId string
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    CmkKeyVaultKeyUrl string

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with this Azure Bot Service.
    DeveloperAppInsightsApplicationId string
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    DeveloperAppInsightsKey string
    The Application Insight Key to associate with this Azure Bot Service.
    DisplayName string
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    Endpoint string
    The Azure Bot Service endpoint.
    IconUrl string
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    LocalAuthenticationEnabled bool
    Is local authentication enabled? Defaults to true.
    Location string
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    LuisAppIds []string
    A list of LUIS App IDs to associate with this Azure Bot Service.
    LuisKey string
    The LUIS key to associate with this Azure Bot Service.
    MicrosoftAppMsiId string
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppTenantId string
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppType string
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether public network access is enabled. Defaults to true.
    StreamingEndpointEnabled bool
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    Tags map[string]string
    A mapping of tags which should be assigned to this Azure Bot Service.
    microsoftAppId String
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku String
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    cmkKeyVaultKeyUrl String

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developerAppInsightsApiKey String
    The Application Insights API Key to associate with this Azure Bot Service.
    developerAppInsightsApplicationId String
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developerAppInsightsKey String
    The Application Insight Key to associate with this Azure Bot Service.
    displayName String
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint String
    The Azure Bot Service endpoint.
    iconUrl String
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    localAuthenticationEnabled Boolean
    Is local authentication enabled? Defaults to true.
    location String
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luisKey String
    The LUIS key to associate with this Azure Bot Service.
    microsoftAppMsiId String
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppTenantId String
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppType String
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether public network access is enabled. Defaults to true.
    streamingEndpointEnabled Boolean
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags Map<String,String>
    A mapping of tags which should be assigned to this Azure Bot Service.
    microsoftAppId string
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku string
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    cmkKeyVaultKeyUrl string

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developerAppInsightsApiKey string
    The Application Insights API Key to associate with this Azure Bot Service.
    developerAppInsightsApplicationId string
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developerAppInsightsKey string
    The Application Insight Key to associate with this Azure Bot Service.
    displayName string
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint string
    The Azure Bot Service endpoint.
    iconUrl string
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    localAuthenticationEnabled boolean
    Is local authentication enabled? Defaults to true.
    location string
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luisAppIds string[]
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luisKey string
    The LUIS key to associate with this Azure Bot Service.
    microsoftAppMsiId string
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppTenantId string
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppType string
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name string
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Whether public network access is enabled. Defaults to true.
    streamingEndpointEnabled boolean
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to this Azure Bot Service.
    microsoft_app_id str
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku str
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    cmk_key_vault_key_url str

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developer_app_insights_api_key str
    The Application Insights API Key to associate with this Azure Bot Service.
    developer_app_insights_application_id str
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developer_app_insights_key str
    The Application Insight Key to associate with this Azure Bot Service.
    display_name str
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint str
    The Azure Bot Service endpoint.
    icon_url str
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    local_authentication_enabled bool
    Is local authentication enabled? Defaults to true.
    location str
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luis_app_ids Sequence[str]
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luis_key str
    The LUIS key to associate with this Azure Bot Service.
    microsoft_app_msi_id str
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoft_app_tenant_id str
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoft_app_type str
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name str
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Whether public network access is enabled. Defaults to true.
    streaming_endpoint_enabled bool
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to this Azure Bot Service.
    microsoftAppId String
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku String
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    cmkKeyVaultKeyUrl String

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developerAppInsightsApiKey String
    The Application Insights API Key to associate with this Azure Bot Service.
    developerAppInsightsApplicationId String
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developerAppInsightsKey String
    The Application Insight Key to associate with this Azure Bot Service.
    displayName String
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint String
    The Azure Bot Service endpoint.
    iconUrl String
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    localAuthenticationEnabled Boolean
    Is local authentication enabled? Defaults to true.
    location String
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luisKey String
    The LUIS key to associate with this Azure Bot Service.
    microsoftAppMsiId String
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppTenantId String
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppType String
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether public network access is enabled. Defaults to true.
    streamingEndpointEnabled Boolean
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags Map<String>
    A mapping of tags which should be assigned to this Azure Bot Service.

    Outputs

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

    Get an existing ServiceAzureBot 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?: ServiceAzureBotState, opts?: CustomResourceOptions): ServiceAzureBot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cmk_key_vault_key_url: Optional[str] = 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,
            icon_url: Optional[str] = None,
            local_authentication_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            luis_app_ids: Optional[Sequence[str]] = None,
            luis_key: Optional[str] = None,
            microsoft_app_id: Optional[str] = None,
            microsoft_app_msi_id: Optional[str] = None,
            microsoft_app_tenant_id: Optional[str] = None,
            microsoft_app_type: Optional[str] = None,
            name: Optional[str] = None,
            public_network_access_enabled: Optional[bool] = None,
            resource_group_name: Optional[str] = None,
            sku: Optional[str] = None,
            streaming_endpoint_enabled: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None) -> ServiceAzureBot
    func GetServiceAzureBot(ctx *Context, name string, id IDInput, state *ServiceAzureBotState, opts ...ResourceOption) (*ServiceAzureBot, error)
    public static ServiceAzureBot Get(string name, Input<string> id, ServiceAzureBotState? state, CustomResourceOptions? opts = null)
    public static ServiceAzureBot get(String name, Output<String> id, ServiceAzureBotState 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:
    CmkKeyVaultKeyUrl string

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with this Azure Bot Service.
    DeveloperAppInsightsApplicationId string
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    DeveloperAppInsightsKey string
    The Application Insight Key to associate with this Azure Bot Service.
    DisplayName string
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    Endpoint string
    The Azure Bot Service endpoint.
    IconUrl string
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    LocalAuthenticationEnabled bool
    Is local authentication enabled? Defaults to true.
    Location string
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    LuisAppIds List<string>
    A list of LUIS App IDs to associate with this Azure Bot Service.
    LuisKey string
    The LUIS key to associate with this Azure Bot Service.
    MicrosoftAppId string
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppMsiId string
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppTenantId string
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppType string
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether public network access is enabled. Defaults to true.
    ResourceGroupName string
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    StreamingEndpointEnabled bool
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to this Azure Bot Service.
    CmkKeyVaultKeyUrl string

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    DeveloperAppInsightsApiKey string
    The Application Insights API Key to associate with this Azure Bot Service.
    DeveloperAppInsightsApplicationId string
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    DeveloperAppInsightsKey string
    The Application Insight Key to associate with this Azure Bot Service.
    DisplayName string
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    Endpoint string
    The Azure Bot Service endpoint.
    IconUrl string
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    LocalAuthenticationEnabled bool
    Is local authentication enabled? Defaults to true.
    Location string
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    LuisAppIds []string
    A list of LUIS App IDs to associate with this Azure Bot Service.
    LuisKey string
    The LUIS key to associate with this Azure Bot Service.
    MicrosoftAppId string
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppMsiId string
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppTenantId string
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    MicrosoftAppType string
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    Name string
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether public network access is enabled. Defaults to true.
    ResourceGroupName string
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    StreamingEndpointEnabled bool
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    Tags map[string]string
    A mapping of tags which should be assigned to this Azure Bot Service.
    cmkKeyVaultKeyUrl String

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developerAppInsightsApiKey String
    The Application Insights API Key to associate with this Azure Bot Service.
    developerAppInsightsApplicationId String
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developerAppInsightsKey String
    The Application Insight Key to associate with this Azure Bot Service.
    displayName String
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint String
    The Azure Bot Service endpoint.
    iconUrl String
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    localAuthenticationEnabled Boolean
    Is local authentication enabled? Defaults to true.
    location String
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luisKey String
    The LUIS key to associate with this Azure Bot Service.
    microsoftAppId String
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppMsiId String
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppTenantId String
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppType String
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether public network access is enabled. Defaults to true.
    resourceGroupName String
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku String
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    streamingEndpointEnabled Boolean
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags Map<String,String>
    A mapping of tags which should be assigned to this Azure Bot Service.
    cmkKeyVaultKeyUrl string

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developerAppInsightsApiKey string
    The Application Insights API Key to associate with this Azure Bot Service.
    developerAppInsightsApplicationId string
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developerAppInsightsKey string
    The Application Insight Key to associate with this Azure Bot Service.
    displayName string
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint string
    The Azure Bot Service endpoint.
    iconUrl string
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    localAuthenticationEnabled boolean
    Is local authentication enabled? Defaults to true.
    location string
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luisAppIds string[]
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luisKey string
    The LUIS key to associate with this Azure Bot Service.
    microsoftAppId string
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppMsiId string
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppTenantId string
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppType string
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name string
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Whether public network access is enabled. Defaults to true.
    resourceGroupName string
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku string
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    streamingEndpointEnabled boolean
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to this Azure Bot Service.
    cmk_key_vault_key_url str

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developer_app_insights_api_key str
    The Application Insights API Key to associate with this Azure Bot Service.
    developer_app_insights_application_id str
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developer_app_insights_key str
    The Application Insight Key to associate with this Azure Bot Service.
    display_name str
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint str
    The Azure Bot Service endpoint.
    icon_url str
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    local_authentication_enabled bool
    Is local authentication enabled? Defaults to true.
    location str
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luis_app_ids Sequence[str]
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luis_key str
    The LUIS key to associate with this Azure Bot Service.
    microsoft_app_id str
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    microsoft_app_msi_id str
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoft_app_tenant_id str
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoft_app_type str
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name str
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Whether public network access is enabled. Defaults to true.
    resource_group_name str
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku str
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    streaming_endpoint_enabled bool
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to this Azure Bot Service.
    cmkKeyVaultKeyUrl String

    The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.

    Note: In order to utilize CMEK, you must add the Key Vault Crypto Service Encryption User role to the Azure-defined Bot Service CMEK Prod Service Principal. You must also enable soft_delete_enabled and purge_protection_enabled on the azure.keyvault.KeyVault that cmk_key_vault_key_url refers to. See Azure Documentation

    developerAppInsightsApiKey String
    The Application Insights API Key to associate with this Azure Bot Service.
    developerAppInsightsApplicationId String
    The resource ID of the Application Insights instance to associate with this Azure Bot Service.
    developerAppInsightsKey String
    The Application Insight Key to associate with this Azure Bot Service.
    displayName String
    The name that the Azure Bot Service will be displayed as. This defaults to the value set for name if not specified.
    endpoint String
    The Azure Bot Service endpoint.
    iconUrl String
    The Icon Url of the Azure Bot Service. Defaults to https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png.
    localAuthenticationEnabled Boolean
    Is local authentication enabled? Defaults to true.
    location String
    The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    luisAppIds List<String>
    A list of LUIS App IDs to associate with this Azure Bot Service.
    luisKey String
    The LUIS key to associate with this Azure Bot Service.
    microsoftAppId String
    The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppMsiId String
    The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppTenantId String
    The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
    microsoftAppType String
    The Microsoft App Type for this Azure Bot Service. Possible values are MultiTenant, SingleTenant and UserAssignedMSI. Changing this forces a new resource to be created.
    name String
    The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether public network access is enabled. Defaults to true.
    resourceGroupName String
    The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
    sku String
    The SKU of the Azure Bot Service. Accepted values are F0 or S1. Changing this forces a new resource to be created.
    streamingEndpointEnabled Boolean
    Is the streaming endpoint enabled for this Azure Bot Service. Defaults to false.
    tags Map<String>
    A mapping of tags which should be assigned to this Azure Bot Service.

    Import

    Azure Bot Services can be imported using the resource id, e.g.

    $ pulumi import azure:bot/serviceAzureBot:ServiceAzureBot example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.BotService/botServices/botService1
    

    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 Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi