azurermBotConnection
Manages a Bot Connection.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const dataAzurermClientConfigCurrent =
new azurerm.dataAzurermClientConfig.DataAzurermClientConfig(
this,
"current",
{}
);
const azurermBotChannelsRegistrationExample =
new azurerm.botChannelsRegistration.BotChannelsRegistration(
this,
"example_2",
{
location: "global",
microsoft_app_id: dataAzurermClientConfigCurrent.clientId,
name: "example",
resource_group_name: azurermResourceGroupExample.name,
sku: "F0",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermBotChannelsRegistrationExample.overrideLogicalId("example");
const azurermBotConnectionExample = new azurerm.botConnection.BotConnection(
this,
"example_3",
{
bot_name: azurermBotChannelsRegistrationExample.name,
client_id: "exampleId",
client_secret: "exampleSecret",
location: azurermBotChannelsRegistrationExample.location,
name: "example",
resource_group_name: azurermResourceGroupExample.name,
service_provider_name: "box",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermBotConnectionExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
name
- (Required) Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique. -
resourceGroupName
- (Required) The name of the resource group in which to create the Bot Connection. Changing this forces a new resource to be created. -
location
- (Required) The supported Azure location where the resource exists. Changing this forces a new resource to be created. -
botName
- (Required) The name of the Bot Resource this connection will be associated with. Changing this forces a new resource to be created. -
serviceProviderName
- (Required) The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created. -
clientId
- (Required) The Client ID that will be used to authenticate with the service provider. -
clientSecret
- (Required) The Client Secret that will be used to authenticate with the service provider. -
scopes
- (Optional) The Scopes at which the connection should be applied. -
parameters
- (Optional) A map of additional parameters to apply to the connection. -
tags
- (Optional) A mapping of tags to assign to the resource.
-> Note: tags
has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.
Attributes Reference
The following attributes are exported:
id
- The ID of the Bot Connection.
Timeouts
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the Bot Connection.update
- (Defaults to 30 minutes) Used when updating the Bot Connection.read
- (Defaults to 5 minutes) Used when retrieving the Bot Connection.delete
- (Defaults to 30 minutes) Used when deleting the Bot Connection.
Import
Bot Connection can be imported using the resourceId
, e.g.