Share via

BotProperties interface

Package:
@azure/arm-botservice

The parameters to provide for the Bot.

Properties

allSettings

Contains resource all settings defined as key/value pairs.
appPasswordHint

The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
cmekEncryptionStatus

The CMK encryption status NOTE: This property will not be serialized. It can only be populated by the server.
cmekKeyVaultUrl

The CMK Url
configuredChannels

Collection of channels for which the bot is configured NOTE: This property will not be serialized. It can only be populated by the server.
description

The description of the bot
developerAppInsightKey

The Application Insights key
developerAppInsightsApiKey

The Application Insights Api Key
developerAppInsightsApplicationId

The Application Insights App Id
disableLocalAuth

Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
displayName

The Name of the bot
enabledChannels

Collection of channels for which the bot is enabled NOTE: This property will not be serialized. It can only be populated by the server.
endpoint

The bot's endpoint
endpointVersion

The bot's endpoint version NOTE: This property will not be serialized. It can only be populated by the server.
iconUrl

The Icon Url of the bot
isCmekEnabled

Whether Cmek is enabled
isDeveloperAppInsightsApiKeySet

Whether the bot is developerAppInsightsApiKey set NOTE: This property will not be serialized. It can only be populated by the server.
isStreamingSupported

Whether the bot is streaming supported
luisAppIds

Collection of LUIS App Ids
luisKey

The LUIS Key
manifestUrl

The bot's manifest url
migrationToken

Token used to migrate non Azure bot to azure subscription NOTE: This property will not be serialized. It can only be populated by the server.
msaAppId

Microsoft App Id for the bot
msaAppMSIResourceId

Microsoft App Managed Identity Resource Id for the bot
msaAppTenantId

Microsoft App Tenant Id for the bot
msaAppType

Microsoft App Type for the bot
openWithHint

The hint to browser (e.g. protocol handler) on how to open the bot for authoring
parameters

Contains resource parameters defined as key/value pairs.
privateEndpointConnections

List of Private Endpoint Connections configured for the bot NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Provisioning state of the resource NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Whether the bot is in an isolated network
publishingCredentials

Publishing credentials of the resource
schemaTransformationVersion

The channel schema transformation version for the bot
storageResourceId

The storage resourceId for the bot
tenantId

The Tenant Id for the bot

Property Details

allSettings

Contains resource all settings defined as key/value pairs.

allSettings?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

appPasswordHint

The hint (e.g. keyVault secret resourceId) on how to fetch the app secret

appPasswordHint?: string

Property Value

string

cmekEncryptionStatus

The CMK encryption status NOTE: This property will not be serialized. It can only be populated by the server.

cmekEncryptionStatus?: string

Property Value

string

cmekKeyVaultUrl

The CMK Url

cmekKeyVaultUrl?: string

Property Value

string

configuredChannels

Collection of channels for which the bot is configured NOTE: This property will not be serialized. It can only be populated by the server.

configuredChannels?: string[]

Property Value

string[]

description

The description of the bot

description?: string

Property Value

string

developerAppInsightKey

The Application Insights key

developerAppInsightKey?: string

Property Value

string

developerAppInsightsApiKey

The Application Insights Api Key

developerAppInsightsApiKey?: string

Property Value

string

developerAppInsightsApplicationId

The Application Insights App Id

developerAppInsightsApplicationId?: string

Property Value

string

disableLocalAuth

Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

disableLocalAuth?: boolean

Property Value

boolean

displayName

The Name of the bot

displayName: string

Property Value

string

enabledChannels

Collection of channels for which the bot is enabled NOTE: This property will not be serialized. It can only be populated by the server.

enabledChannels?: string[]

Property Value

string[]

endpoint

The bot's endpoint

endpoint: null | string

Property Value

null | string

endpointVersion

The bot's endpoint version NOTE: This property will not be serialized. It can only be populated by the server.

endpointVersion?: string

Property Value

string

iconUrl

The Icon Url of the bot

iconUrl?: string

Property Value

string

isCmekEnabled

Whether Cmek is enabled

isCmekEnabled?: boolean

Property Value

boolean

isDeveloperAppInsightsApiKeySet

Whether the bot is developerAppInsightsApiKey set NOTE: This property will not be serialized. It can only be populated by the server.

isDeveloperAppInsightsApiKeySet?: boolean

Property Value

boolean

isStreamingSupported

Whether the bot is streaming supported

isStreamingSupported?: boolean

Property Value

boolean

luisAppIds

Collection of LUIS App Ids

luisAppIds?: string[]

Property Value

string[]

luisKey

The LUIS Key

luisKey?: string

Property Value

string

manifestUrl

The bot's manifest url

manifestUrl?: string

Property Value

string

migrationToken

Token used to migrate non Azure bot to azure subscription NOTE: This property will not be serialized. It can only be populated by the server.

migrationToken?: string

Property Value

string

msaAppId

Microsoft App Id for the bot

msaAppId: string

Property Value

string

msaAppMSIResourceId

Microsoft App Managed Identity Resource Id for the bot

msaAppMSIResourceId?: string

Property Value

string

msaAppTenantId

Microsoft App Tenant Id for the bot

msaAppTenantId?: string

Property Value

string

msaAppType

Microsoft App Type for the bot

msaAppType?: string

Property Value

string

openWithHint

The hint to browser (e.g. protocol handler) on how to open the bot for authoring

openWithHint?: string

Property Value

string

parameters

Contains resource parameters defined as key/value pairs.

parameters?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

privateEndpointConnections

List of Private Endpoint Connections configured for the bot NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Provisioning state of the resource NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether the bot is in an isolated network

publicNetworkAccess?: string

Property Value

string

publishingCredentials

Publishing credentials of the resource

publishingCredentials?: string

Property Value

string

schemaTransformationVersion

The channel schema transformation version for the bot

schemaTransformationVersion?: string

Property Value

string

storageResourceId

The storage resourceId for the bot

storageResourceId?: string

Property Value

string

tenantId

The Tenant Id for the bot

tenantId?: string

Property Value

string