Module bot-service

botService

Property	Value	Description
general (required)	general
allSettings	allSettings
appPasswordHint	string	The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
cmekKeyVaultUrl	string	The CMK Url
description	string	The description of the bot
developerAppInsightKey	string	The Application Insights key
developerAppInsightsApiKey	string	The Application Insights Api Key
developerAppInsightsApplicationId	string	The Application Insights App Id
disableLocalAuth	bool	Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
displayName (required)	string	The Name of the bot
endpoint (required)	string	The bots endpoint
iconUrl	string	The Icon Url of the bot
isCmekEnabled	bool	Whether Cmek is enabled
isStreamingSupported	bool	Whether the bot is streaming supported
luisAppIds	string[]	Collection of LUIS App Ids
luisKey	string	The LUIS Key
manifestUrl	string	The bots manifest url
appRegistrationClientId (required)	string	The appregistration Client / Application ID of the The Microsoft App Registration
managedIdentityResourceId	string	The appregistration Client / Microsoft App Managed Identity Resource Id for the bot
appRegistrationTenantId	string	The appregistration Client / Microsoft App Tenant Id for the bot
appRegistrationAppType (required)	'MultiTenant' 'SingleTenant' 'UserAssignedMSI'	Microsoft App Type for the bot
openWithHint	string	The hint to browser (e.g. protocol handler) on how to open the bot for authoring
parameters	parameters	Whether the bot is in an isolated network
publicNetworkAccess (required)	'Disabled' 'Enabled' 'SecuredByPerimeter'
publishingCredentials	string	Publishing credentials of the resource
schemaTransformationVersion	string	The channel schema transformation version for the bot
storageResourceId	string	The storage resourceId for the bot
tenantId (required)	string	The Tenant Id for the bot
sku (required)	sku	Gets or sets the SKU of the resource.
kind (required)	'azurebot' 'bot' 'designer' 'function' 'sdk'	Required. Gets or sets the Kind of the resource.

allSettings

Property	Value	Description

• (required) | string |

parameters

Property	Value	Description

• (required) | string |

sku

Property	Value	Description
name (required)	'F0' 'S1'

naming

Property	Value	Description
forceFunctionAsFullName	bool	Use the function value as the full name of the resource
abbreviation	string	Override the abbreviation of this resource with this parameter
environment	string	The resource environment (for example: dev, tst, acc, prd)
location	string	The resource location (for example: weu, we, westeurope)
customer	string	The name of the customer
delimiter	string	The delimiter between resources (default: -)
nameFormat	Array containing any of: 'abbreviation' 'customer' 'environment' 'function' 'location' 'param1' 'param2' 'param3' 'useCaseName'	The order of the array defines the order of elements in the naming scheme
param1	string	Extra parameter self defined
param2	string	Extra parameter self defined
param3	string	Extra parameter self defined
function (required)	string	Function of the resource [can be app, db, security,...]
useCaseName	string	Name of the use case [can be hub, spoke,...]
suffix	string	Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...]
forceDefaultNaming	bool	Force the CAF naming instead of default company naming

resourceLock

Property	Value	Description
name	string	Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Cant end in period.
level (required)	'CanNotDelete' 'ReadOnly'	The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they cant modify or delete it. Read-Only locks must be commented to be able to deploy again
notes	string	Notes about the lock. Maximum of 512 characters.
owners	resourceLockOwner[]	The owners of the lock

resourceLockOwner

Property	Value	Description
applicationId (required)	string	The application ID of the lock owner.

roleAssignment

Property	Value	Description
principalId (required)	string	The principal ID
roleDefinitionId (required)	string	The role definition ID, data file can be used for this
condition	string	Condition on the role assignment
conditionVersion	string	Version of the condition. Currently the only accepted value is "2.0"
delegatedManagedIdentityResourceId	string	Id of the delegated managed identity resource
description	string	Description of role assignment
principalType (required)	'Device' 'ForeignGroup' 'Group' 'ServicePrincipal' 'User'	The principal type of the assigned principal ID

general

Property	Value	Description
tags	object	Tags of the resource [hashtable]
location (required)	string	Location of the resource
naming (required)	naming	Naming module of the resource
resourceGroupName (required)	string	Name of the resource group where the resource should be located
sharedNaming (required)	naming	Reference to the default naming
roleAssignments	roleAssignment[]	Role assignments on the resource
resourceLocks	resourceLock[]	Resource Locks on the resource

Changelog

1.1.2 (2025-09-24)

Bug Fixes

• remove deployment name + cleanup

1.1.1 (2025-04-29)

Bug Fixes

• make endpoint parameter optional
• resolve issue with incorrect defaults

1.1.0 (2025-03-26)

Features

• add resourceName output

1.0.1 (2025-02-28)

Bug Fixes

• revise descriptions

1.0.0 (2025-01-30)

Features

• add initial release