azurermBotChannelSms
Manages a SMS integration for a Bot Channel
\~> Note A bot can only have a single SMS Channel associated with it.
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-bcr",
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 azurermBotChannelSmsExample = new azurerm.botChannelSms.BotChannelSms(
this,
"example_3",
{
bot_name: azurermBotChannelsRegistrationExample.name,
location: azurermBotChannelsRegistrationExample.location,
phone_number: "+12313803556",
resource_group_name: azurermResourceGroupExample.name,
sms_channel_account_security_id: "BG61f7cf5157f439b084e98256409c2815",
sms_channel_auth_token: "jh8980432610052ed4e29565c5e232f",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermBotChannelSmsExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
resourceGroupName- (Required) The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created. -
location- (Required) Specifies 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 channel will be associated with. Changing this forces a new resource to be created. -
phoneNumber- (Required) The phone number for the SMS Channel. -
smsChannelAccountSecurityId- (Required) The account security identifier (SID) for the SMS Channel. -
smsChannelAuthToken- (Required) The authorization token for the SMS Channel.
Attributes Reference
The following attributes are exported:
id- The ID of the SMS Integration for a Bot Channel.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the SMS Integration for a Bot Channel.update- (Defaults to 30 minutes) Used when updating the SMS Integration for a Bot Channel.read- (Defaults to 5 minutes) Used when retrieving the SMS Integration for a Bot Channel.delete- (Defaults to 30 minutes) Used when deleting the SMS Integration for a Bot Channel.
Import
The SMS Integration for a Bot Channel can be imported using the resourceId, e.g.