BotProperties Class

Package:

com.azure.resourcemanager.botservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-botservice:1.0.0-beta.6

• java.lang.Object
• • com.azure.resourcemanager.botservice.models.BotProperties

Implements

JsonSerializable<BotProperties>

public final class BotProperties
implements JsonSerializable<BotProperties>

The parameters to provide for the Bot.

Constructor Summary

Constructor	Description
BotProperties()	Creates an instance of BotProperties class.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	allSettings() Get the allSettings property: Contains resource all settings defined as key/value pairs.
String	appPasswordHint() Get the appPasswordHint property: The hint (e.g.
String	cmekEncryptionStatus() Get the cmekEncryptionStatus property: The CMK encryption status.
String	cmekKeyVaultUrl() Get the cmekKeyVaultUrl property: The CMK Url.
List<String>	configuredChannels() Get the configuredChannels property: Collection of channels for which the bot is configured.
String	description() Get the description property: The description of the bot.
String	developerAppInsightKey() Get the developerAppInsightKey property: The Application Insights key.
String	developerAppInsightsApiKey() Get the developerAppInsightsApiKey property: The Application Insights Api Key.
String	developerAppInsightsApplicationId() Get the developerAppInsightsApplicationId property: The Application Insights App Id.
Boolean	disableLocalAuth() Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
String	displayName() Get the displayName property: The Name of the bot.
List<String>	enabledChannels() Get the enabledChannels property: Collection of channels for which the bot is enabled.
String	endpoint() Get the endpoint property: The bot's endpoint.
String	endpointVersion() Get the endpointVersion property: The bot's endpoint version.
static BotProperties	fromJson(JsonReader jsonReader) Reads an instance of BotProperties from the JsonReader.
String	iconUrl() Get the iconUrl property: The Icon Url of the bot.
Boolean	isCmekEnabled() Get the isCmekEnabled property: Whether Cmek is enabled.
Boolean	isDeveloperAppInsightsApiKeySet() Get the isDeveloperAppInsightsApiKeySet property: Whether the bot is developerAppInsightsApiKey set.
Boolean	isStreamingSupported() Get the isStreamingSupported property: Whether the bot is streaming supported.
List<String>	luisAppIds() Get the luisAppIds property: Collection of LUIS App Ids.
String	luisKey() Get the luisKey property: The LUIS Key.
String	manifestUrl() Get the manifestUrl property: The bot's manifest url.
String	migrationToken() Get the migrationToken property: Token used to migrate non Azure bot to azure subscription.
String	msaAppId() Get the msaAppId property: Microsoft App Id for the bot.
String	msaAppMsiResourceId() Get the msaAppMsiResourceId property: Microsoft App Managed Identity Resource Id for the bot.
String	msaAppTenantId() Get the msaAppTenantId property: Microsoft App Tenant Id for the bot.
MsaAppType	msaAppType() Get the msaAppType property: Microsoft App Type for the bot.
String	openWithHint() Get the openWithHint property: The hint to browser (e.g.
Map<String,String>	parameters() Get the parameters property: Contains resource parameters defined as key/value pairs.
List<PrivateEndpointConnectionInner>	privateEndpointConnections() Get the privateEndpointConnections property: List of Private Endpoint Connections configured for the bot.
String	provisioningState() Get the provisioningState property: Provisioning state of the resource.
PublicNetworkAccess	publicNetworkAccess() Get the publicNetworkAccess property: Whether the bot is in an isolated network.
String	publishingCredentials() Get the publishingCredentials property: Publishing credentials of the resource.
String	schemaTransformationVersion() Get the schemaTransformationVersion property: The channel schema transformation version for the bot.
String	storageResourceId() Get the storageResourceId property: The storage resourceId for the bot.
String	tenantId() Get the tenantId property: The Tenant Id for the bot.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
BotProperties	withAllSettings(Map<String,String> allSettings) Set the allSettings property: Contains resource all settings defined as key/value pairs.
BotProperties	withAppPasswordHint(String appPasswordHint) Set the appPasswordHint property: The hint (e.g.
BotProperties	withCmekKeyVaultUrl(String cmekKeyVaultUrl) Set the cmekKeyVaultUrl property: The CMK Url.
BotProperties	withDescription(String description) Set the description property: The description of the bot.
BotProperties	withDeveloperAppInsightKey(String developerAppInsightKey) Set the developerAppInsightKey property: The Application Insights key.
BotProperties	withDeveloperAppInsightsApiKey(String developerAppInsightsApiKey) Set the developerAppInsightsApiKey property: The Application Insights Api Key.
BotProperties	withDeveloperAppInsightsApplicationId(String developerAppInsightsApplicationId) Set the developerAppInsightsApplicationId property: The Application Insights App Id.
BotProperties	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
BotProperties	withDisplayName(String displayName) Set the displayName property: The Name of the bot.
BotProperties	withEndpoint(String endpoint) Set the endpoint property: The bot's endpoint.
BotProperties	withIconUrl(String iconUrl) Set the iconUrl property: The Icon Url of the bot.
BotProperties	withIsCmekEnabled(Boolean isCmekEnabled) Set the isCmekEnabled property: Whether Cmek is enabled.
BotProperties	withIsStreamingSupported(Boolean isStreamingSupported) Set the isStreamingSupported property: Whether the bot is streaming supported.
BotProperties	withLuisAppIds(List<String> luisAppIds) Set the luisAppIds property: Collection of LUIS App Ids.
BotProperties	withLuisKey(String luisKey) Set the luisKey property: The LUIS Key.
BotProperties	withManifestUrl(String manifestUrl) Set the manifestUrl property: The bot's manifest url.
BotProperties	withMsaAppId(String msaAppId) Set the msaAppId property: Microsoft App Id for the bot.
BotProperties	withMsaAppMsiResourceId(String msaAppMsiResourceId) Set the msaAppMsiResourceId property: Microsoft App Managed Identity Resource Id for the bot.
BotProperties	withMsaAppTenantId(String msaAppTenantId) Set the msaAppTenantId property: Microsoft App Tenant Id for the bot.
BotProperties	withMsaAppType(MsaAppType msaAppType) Set the msaAppType property: Microsoft App Type for the bot.
BotProperties	withOpenWithHint(String openWithHint) Set the openWithHint property: The hint to browser (e.g.
BotProperties	withParameters(Map<String,String> parameters) Set the parameters property: Contains resource parameters defined as key/value pairs.
BotProperties	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether the bot is in an isolated network.
BotProperties	withPublishingCredentials(String publishingCredentials) Set the publishingCredentials property: Publishing credentials of the resource.
BotProperties	withSchemaTransformationVersion(String schemaTransformationVersion) Set the schemaTransformationVersion property: The channel schema transformation version for the bot.
BotProperties	withStorageResourceId(String storageResourceId) Set the storageResourceId property: The storage resourceId for the bot.
BotProperties	withTenantId(String tenantId) Set the tenantId property: The Tenant Id for the bot.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BotProperties

public BotProperties()

Creates an instance of BotProperties class.

Method Details

allSettings

public Map<String,String> allSettings()

Get the allSettings property: Contains resource all settings defined as key/value pairs.

Returns:

the allSettings value.

appPasswordHint

public String appPasswordHint()

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

Returns:

the appPasswordHint value.

cmekEncryptionStatus

public String cmekEncryptionStatus()

Get the cmekEncryptionStatus property: The CMK encryption status.

Returns:

the cmekEncryptionStatus value.

cmekKeyVaultUrl

public String cmekKeyVaultUrl()

Get the cmekKeyVaultUrl property: The CMK Url.

Returns:

the cmekKeyVaultUrl value.

configuredChannels

public List<String> configuredChannels()

Get the configuredChannels property: Collection of channels for which the bot is configured.

Returns:

the configuredChannels value.

description

public String description()

Get the description property: The description of the bot.

Returns:

the description value.

developerAppInsightKey

public String developerAppInsightKey()

Get the developerAppInsightKey property: The Application Insights key.

Returns:

the developerAppInsightKey value.

developerAppInsightsApiKey

public String developerAppInsightsApiKey()

Get the developerAppInsightsApiKey property: The Application Insights Api Key.

Returns:

the developerAppInsightsApiKey value.

developerAppInsightsApplicationId

public String developerAppInsightsApplicationId()

Get the developerAppInsightsApplicationId property: The Application Insights App Id.

Returns:

the developerAppInsightsApplicationId value.

disableLocalAuth

public Boolean disableLocalAuth()

Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

Returns:

the disableLocalAuth value.

displayName

public String displayName()

Get the displayName property: The Name of the bot.

Returns:

the displayName value.

enabledChannels

public List<String> enabledChannels()

Get the enabledChannels property: Collection of channels for which the bot is enabled.

Returns:

the enabledChannels value.

endpoint

public String endpoint()

Get the endpoint property: The bot's endpoint.

Returns:

the endpoint value.

endpointVersion

public String endpointVersion()

Get the endpointVersion property: The bot's endpoint version.

Returns:

the endpointVersion value.

fromJson

public static BotProperties fromJson(JsonReader jsonReader)

Reads an instance of BotProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BotProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

iconUrl

public String iconUrl()

Get the iconUrl property: The Icon Url of the bot.

Returns:

the iconUrl value.

isCmekEnabled

public Boolean isCmekEnabled()

Get the isCmekEnabled property: Whether Cmek is enabled.

Returns:

the isCmekEnabled value.

isDeveloperAppInsightsApiKeySet

public Boolean isDeveloperAppInsightsApiKeySet()

Get the isDeveloperAppInsightsApiKeySet property: Whether the bot is developerAppInsightsApiKey set.

Returns:

the isDeveloperAppInsightsApiKeySet value.

isStreamingSupported

public Boolean isStreamingSupported()

Get the isStreamingSupported property: Whether the bot is streaming supported.

Returns:

the isStreamingSupported value.

luisAppIds

public List<String> luisAppIds()

Get the luisAppIds property: Collection of LUIS App Ids.

Returns:

the luisAppIds value.

luisKey

public String luisKey()

Get the luisKey property: The LUIS Key.

Returns:

the luisKey value.

manifestUrl

public String manifestUrl()

Get the manifestUrl property: The bot's manifest url.

Returns:

the manifestUrl value.

migrationToken

public String migrationToken()

Get the migrationToken property: Token used to migrate non Azure bot to azure subscription.

Returns:

the migrationToken value.

msaAppId

public String msaAppId()

Get the msaAppId property: Microsoft App Id for the bot.

Returns:

the msaAppId value.

msaAppMsiResourceId

public String msaAppMsiResourceId()

Get the msaAppMsiResourceId property: Microsoft App Managed Identity Resource Id for the bot.

Returns:

the msaAppMsiResourceId value.

msaAppTenantId

public String msaAppTenantId()

Get the msaAppTenantId property: Microsoft App Tenant Id for the bot.

Returns:

the msaAppTenantId value.

msaAppType

public MsaAppType msaAppType()

Get the msaAppType property: Microsoft App Type for the bot.

Returns:

the msaAppType value.

openWithHint

public String openWithHint()

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

Returns:

the openWithHint value.

parameters

public Map<String,String> parameters()

Get the parameters property: Contains resource parameters defined as key/value pairs.

Returns:

the parameters value.

privateEndpointConnections

public List<PrivateEndpointConnectionInner> privateEndpointConnections()

Get the privateEndpointConnections property: List of Private Endpoint Connections configured for the bot.

Returns:

the privateEndpointConnections value.

provisioningState

public String provisioningState()

Get the provisioningState property: Provisioning state of the resource.

Returns:

the provisioningState value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Whether the bot is in an isolated network.

Returns:

the publicNetworkAccess value.

publishingCredentials

public String publishingCredentials()

Get the publishingCredentials property: Publishing credentials of the resource.

Returns:

the publishingCredentials value.

schemaTransformationVersion

public String schemaTransformationVersion()

Get the schemaTransformationVersion property: The channel schema transformation version for the bot.

Returns:

the schemaTransformationVersion value.

storageResourceId

public String storageResourceId()

Get the storageResourceId property: The storage resourceId for the bot.

Returns:

the storageResourceId value.

tenantId

public String tenantId()

Get the tenantId property: The Tenant Id for the bot.

Returns:

the tenantId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAllSettings

public BotProperties withAllSettings(Map<String,String> allSettings)

Set the allSettings property: Contains resource all settings defined as key/value pairs.

Parameters:

allSettings - the allSettings value to set.

Returns:

the BotProperties object itself.

withAppPasswordHint

public BotProperties withAppPasswordHint(String appPasswordHint)

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

Parameters:

appPasswordHint - the appPasswordHint value to set.

Returns:

the BotProperties object itself.

withCmekKeyVaultUrl

public BotProperties withCmekKeyVaultUrl(String cmekKeyVaultUrl)

Set the cmekKeyVaultUrl property: The CMK Url.

Parameters:

cmekKeyVaultUrl - the cmekKeyVaultUrl value to set.

Returns:

the BotProperties object itself.

withDescription

public BotProperties withDescription(String description)

Set the description property: The description of the bot.

Parameters:

description - the description value to set.

Returns:

the BotProperties object itself.

withDeveloperAppInsightKey

public BotProperties withDeveloperAppInsightKey(String developerAppInsightKey)

Set the developerAppInsightKey property: The Application Insights key.

Parameters:

developerAppInsightKey - the developerAppInsightKey value to set.

Returns:

the BotProperties object itself.

withDeveloperAppInsightsApiKey

public BotProperties withDeveloperAppInsightsApiKey(String developerAppInsightsApiKey)

Set the developerAppInsightsApiKey property: The Application Insights Api Key.

Parameters:

developerAppInsightsApiKey - the developerAppInsightsApiKey value to set.

Returns:

the BotProperties object itself.

withDeveloperAppInsightsApplicationId

public BotProperties withDeveloperAppInsightsApplicationId(String developerAppInsightsApplicationId)

Set the developerAppInsightsApplicationId property: The Application Insights App Id.

Parameters:

developerAppInsightsApplicationId - the developerAppInsightsApplicationId value to set.

Returns:

the BotProperties object itself.

withDisableLocalAuth

public BotProperties withDisableLocalAuth(Boolean disableLocalAuth)

Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

Parameters:

disableLocalAuth - the disableLocalAuth value to set.

Returns:

the BotProperties object itself.

withDisplayName

public BotProperties withDisplayName(String displayName)

Set the displayName property: The Name of the bot.

Parameters:

displayName - the displayName value to set.

Returns:

the BotProperties object itself.

withEndpoint

public BotProperties withEndpoint(String endpoint)

Set the endpoint property: The bot's endpoint.

Parameters:

endpoint - the endpoint value to set.

Returns:

the BotProperties object itself.

withIconUrl

public BotProperties withIconUrl(String iconUrl)

Set the iconUrl property: The Icon Url of the bot.

Parameters:

iconUrl - the iconUrl value to set.

Returns:

the BotProperties object itself.

withIsCmekEnabled

public BotProperties withIsCmekEnabled(Boolean isCmekEnabled)

Set the isCmekEnabled property: Whether Cmek is enabled.

Parameters:

isCmekEnabled - the isCmekEnabled value to set.

Returns:

the BotProperties object itself.

withIsStreamingSupported

public BotProperties withIsStreamingSupported(Boolean isStreamingSupported)

Set the isStreamingSupported property: Whether the bot is streaming supported.

Parameters:

isStreamingSupported - the isStreamingSupported value to set.

Returns:

the BotProperties object itself.

withLuisAppIds

public BotProperties withLuisAppIds(List<String> luisAppIds)

Set the luisAppIds property: Collection of LUIS App Ids.

Parameters:

luisAppIds - the luisAppIds value to set.

Returns:

the BotProperties object itself.

withLuisKey

public BotProperties withLuisKey(String luisKey)

Set the luisKey property: The LUIS Key.

Parameters:

luisKey - the luisKey value to set.

Returns:

the BotProperties object itself.

withManifestUrl

public BotProperties withManifestUrl(String manifestUrl)

Set the manifestUrl property: The bot's manifest url.

Parameters:

manifestUrl - the manifestUrl value to set.

Returns:

the BotProperties object itself.

withMsaAppId

public BotProperties withMsaAppId(String msaAppId)

Set the msaAppId property: Microsoft App Id for the bot.

Parameters:

msaAppId - the msaAppId value to set.

Returns:

the BotProperties object itself.

withMsaAppMsiResourceId

public BotProperties withMsaAppMsiResourceId(String msaAppMsiResourceId)

Set the msaAppMsiResourceId property: Microsoft App Managed Identity Resource Id for the bot.

Parameters:

msaAppMsiResourceId - the msaAppMsiResourceId value to set.

Returns:

the BotProperties object itself.

withMsaAppTenantId

public BotProperties withMsaAppTenantId(String msaAppTenantId)

Set the msaAppTenantId property: Microsoft App Tenant Id for the bot.

Parameters:

msaAppTenantId - the msaAppTenantId value to set.

Returns:

the BotProperties object itself.

withMsaAppType

public BotProperties withMsaAppType(MsaAppType msaAppType)

Set the msaAppType property: Microsoft App Type for the bot.

Parameters:

msaAppType - the msaAppType value to set.

Returns:

the BotProperties object itself.

withOpenWithHint

public BotProperties withOpenWithHint(String openWithHint)

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

Parameters:

openWithHint - the openWithHint value to set.

Returns:

the BotProperties object itself.

withParameters

public BotProperties withParameters(Map<String,String> parameters)

Set the parameters property: Contains resource parameters defined as key/value pairs.

Parameters:

parameters - the parameters value to set.

Returns:

the BotProperties object itself.

withPublicNetworkAccess

public BotProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: Whether the bot is in an isolated network.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the BotProperties object itself.

withPublishingCredentials

public BotProperties withPublishingCredentials(String publishingCredentials)

Set the publishingCredentials property: Publishing credentials of the resource.

Parameters:

publishingCredentials - the publishingCredentials value to set.

Returns:

the BotProperties object itself.

withSchemaTransformationVersion

public BotProperties withSchemaTransformationVersion(String schemaTransformationVersion)

Set the schemaTransformationVersion property: The channel schema transformation version for the bot.

Parameters:

schemaTransformationVersion - the schemaTransformationVersion value to set.

Returns:

the BotProperties object itself.

withStorageResourceId

public BotProperties withStorageResourceId(String storageResourceId)

Set the storageResourceId property: The storage resourceId for the bot.

Parameters:

storageResourceId - the storageResourceId value to set.

Returns:

the BotProperties object itself.

withTenantId

public BotProperties withTenantId(String tenantId)

Set the tenantId property: The Tenant Id for the bot.

Parameters:

tenantId - the tenantId value to set.

Returns:

the BotProperties object itself.