BotProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The parameters to provide for the Bot.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.BotPropertiesTypeConverter))]
public class BotProperties : Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBotProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.BotPropertiesTypeConverter))>]
type BotProperties = class
interface IBotProperties
interface IJsonSerializable
Public Class BotProperties
Implements IBotProperties
- Inheritance
-
BotProperties
- Attributes
- Implements
Constructors
BotProperties() |
Creates an new BotProperties instance. |
Properties
AllSetting |
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 |
CmekKeyVaultUrl |
The CMK Url |
ConfiguredChannel |
Collection of channels for which the bot is configured |
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 |
EnabledChannel |
Collection of channels for which the bot is enabled |
Endpoint |
The bot's endpoint |
EndpointVersion |
The bot's endpoint version |
IconUrl |
The Icon Url of the bot |
IsCmekEnabled |
Whether Cmek is enabled |
IsDeveloperAppInsightsApiKeySet |
Whether the bot is developerAppInsightsApiKey set |
IsStreamingSupported |
Whether the bot is streaming supported |
LuisAppId |
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 |
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 |
Parameter |
Contains resource parameters defined as key/value pairs. |
PrivateEndpointConnection |
List of Private Endpoint Connections configured for the bot |
ProvisioningState |
Provisioning state of the resource |
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 |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of BotProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of BotProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.BotService.Models.Api20220615Preview.IBotProperties. |
FromJsonString(String) |
Creates a new instance of BotProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of BotProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |