@azure/arm-botservice package

Classes

AzureBotService

Interfaces

AcsChatChannel	AcsChat channel definition
AlexaChannel	Alexa channel definition
AlexaChannelProperties	The parameters to provide for the Alexa channel.
AzureBotServiceOptionalParams	Optional parameters.
Bot	Bot resource definition
BotChannel	Bot channel resource definition
BotConnection	Interface representing a BotConnection.
BotConnectionCreateOptionalParams	Optional parameters.
BotConnectionDeleteOptionalParams	Optional parameters.
BotConnectionGetOptionalParams	Optional parameters.
BotConnectionListByBotServiceNextOptionalParams	Optional parameters.
BotConnectionListByBotServiceOptionalParams	Optional parameters.
BotConnectionListServiceProvidersOptionalParams	Optional parameters.
BotConnectionListWithSecretsOptionalParams	Optional parameters.
BotConnectionUpdateOptionalParams	Optional parameters.
BotProperties	The parameters to provide for the Bot.
BotResponseList	The list of bot service operation response.
Bots	Interface representing a Bots.
BotsCreateOptionalParams	Optional parameters.
BotsDeleteOptionalParams	Optional parameters.
BotsGetCheckNameAvailabilityOptionalParams	Optional parameters.
BotsGetOptionalParams	Optional parameters.
BotsListByResourceGroupNextOptionalParams	Optional parameters.
BotsListByResourceGroupOptionalParams	Optional parameters.
BotsListNextOptionalParams	Optional parameters.
BotsListOptionalParams	Optional parameters.
BotsUpdateOptionalParams	Optional parameters.
Channel	Channel definition
ChannelResponseList	The list of bot service channel operation response.
ChannelSettings	Channel settings definition
Channels	Interface representing a Channels.
ChannelsCreateOptionalParams	Optional parameters.
ChannelsDeleteOptionalParams	Optional parameters.
ChannelsGetOptionalParams	Optional parameters.
ChannelsListByResourceGroupNextOptionalParams	Optional parameters.
ChannelsListByResourceGroupOptionalParams	Optional parameters.
ChannelsListWithKeysOptionalParams	Optional parameters.
ChannelsUpdateOptionalParams	Optional parameters.
CheckNameAvailabilityRequestBody	The request body for a request to Bot Service Management to check availability of a bot name.
CheckNameAvailabilityResponseBody	The response body returned for a request to Bot Service Management to check availability of a bot name.
ConnectionItemName	The display name of a connection Item Setting registered with the Bot
ConnectionSetting	Bot channel resource definition
ConnectionSettingParameter	Extra Parameter in a Connection Setting Properties to indicate service provider specific properties
ConnectionSettingProperties	Properties for a Connection Setting Item
ConnectionSettingResponseList	The list of bot service connection settings response.
CreateEmailSignInUrlResponse	The ARM create email sign in url operation response.
CreateEmailSignInUrlResponseProperties	The set of properties specific to sign in url
DirectLine	Interface representing a DirectLine.
DirectLineChannel	Direct Line channel definition
DirectLineChannelProperties	The parameters to provide for the Direct Line channel.
DirectLineRegenerateKeysOptionalParams	Optional parameters.
DirectLineSite	A site for the Direct Line channel
DirectLineSpeechChannel	DirectLine Speech channel definition
DirectLineSpeechChannelProperties	The parameters to provide for the DirectLine Speech channel.
Email	Interface representing a Email.
EmailChannel	Email channel definition
EmailChannelProperties	The parameters to provide for the Email channel.
EmailCreateSignInUrlOptionalParams	Optional parameters.
ErrorBody	Bot Service error body.
ErrorModel	Bot Service error object.
FacebookChannel	Facebook channel definition
FacebookChannelProperties	The parameters to provide for the Facebook channel.
FacebookPage	A Facebook page for Facebook channel registration
HostSettings	Interface representing a HostSettings.
HostSettingsGetOptionalParams	Optional parameters.
HostSettingsResponse	The response body returned for a request to Bot Service Management to check per subscription hostSettings
KikChannel	Kik channel definition
KikChannelProperties	The parameters to provide for the Kik channel.
LineChannel	Line channel definition
LineChannelProperties	The parameters to provide for the Line channel.
LineRegistration	The properties corresponding to a line channel registration
ListChannelWithKeysResponse	The ARM channel of list channel with keys operation response.
M365Extensions	M365 Extensions definition
MsTeamsChannel	Microsoft Teams channel definition
MsTeamsChannelProperties	The parameters to provide for the Microsoft Teams channel.
Omnichannel	Omnichannel channel definition
OperationDisplayInfo	The operation supported by Bot Service Management.
OperationEntity	The operations supported by Bot Service Management.
OperationEntityListResult	The list of bot service operation response.
OperationResults	Interface representing a OperationResults.
OperationResultsDescription	The properties indicating the operation result of an operation on a service.
OperationResultsGetOptionalParams	Optional parameters.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OutlookChannel	Outlook channel definition
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionListResult	List of private endpoint connection associated with the specified storage account
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource
PrivateLinkResourceBase	Common fields that are returned in the response for all BotService Private Link Resources
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesListByBotResourceOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
QnAMakerEndpointKeys	Interface representing a QnAMakerEndpointKeys.
QnAMakerEndpointKeysGetOptionalParams	Optional parameters.
QnAMakerEndpointKeysRequestBody	The request body for a request to Bot Service Management to list QnA Maker endpoint keys.
QnAMakerEndpointKeysResponse	Schema for EndpointKeys generate/refresh operations.
Resource	Azure resource
SearchAssistant	SearchAssistant definition
ServiceProvider	Service Provider Definition
ServiceProviderParameter	Extra Parameters specific to each Service Provider
ServiceProviderParameterMetadata	Meta data for the Service Provider
ServiceProviderParameterMetadataConstraints	the constraints of the bot meta data.
ServiceProviderProperties	The Object used to describe a Service Provider supported by Bot Service
ServiceProviderResponseList	The list of bot service providers response.
Site	A site for the channel
SiteInfo	Site information for WebChat or DirectLine Channels to identify which site to regenerate keys for.
Sku	The SKU of the cognitive services account.
SkypeChannel	Skype channel definition
SkypeChannelProperties	The parameters to provide for the Microsoft Teams channel.
SlackChannel	Slack channel definition
SlackChannelProperties	The parameters to provide for the Slack channel.
SmsChannel	Sms channel definition
SmsChannelProperties	The parameters to provide for the Sms channel.
TelegramChannel	Telegram channel definition
TelegramChannelProperties	The parameters to provide for the Telegram channel.
TelephonyChannel	Telephony channel definition
TelephonyChannelProperties	The parameters to provide for the Direct Line channel.
TelephonyChannelResourceApiConfiguration	A resource Api configuration for the Telephony channel
TelephonyPhoneNumbers	A telephone number for the Telephony channel
WebChatChannel	Web Chat channel definition
WebChatChannelProperties	The parameters to provide for the Web Chat channel.
WebChatSite	A site for the Webchat channel

Type Aliases

BotConnectionCreateResponse	Contains response data for the create operation.
BotConnectionGetResponse	Contains response data for the get operation.
BotConnectionListByBotServiceNextResponse	Contains response data for the listByBotServiceNext operation.
BotConnectionListByBotServiceResponse	Contains response data for the listByBotService operation.
BotConnectionListServiceProvidersResponse	Contains response data for the listServiceProviders operation.
BotConnectionListWithSecretsResponse	Contains response data for the listWithSecrets operation.
BotConnectionUpdateResponse	Contains response data for the update operation.
BotsCreateResponse	Contains response data for the create operation.
BotsGetCheckNameAvailabilityResponse	Contains response data for the getCheckNameAvailability operation.
BotsGetResponse	Contains response data for the get operation.
BotsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
BotsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
BotsListNextResponse	Contains response data for the listNext operation.
BotsListResponse	Contains response data for the list operation.
BotsUpdateResponse	Contains response data for the update operation.
ChannelName	Defines values for ChannelName.
ChannelUnion
ChannelsCreateResponse	Contains response data for the create operation.
ChannelsGetResponse	Contains response data for the get operation.
ChannelsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ChannelsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ChannelsListWithKeysResponse	Contains response data for the listWithKeys operation.
ChannelsUpdateResponse	Contains response data for the update operation.
DirectLineRegenerateKeysResponse	Contains response data for the regenerateKeys operation.
EmailChannelAuthMethod	Defines values for EmailChannelAuthMethod.
EmailCreateSignInUrlResponse	Contains response data for the createSignInUrl operation.
HostSettingsGetResponse	Contains response data for the get operation.
Key	Defines values for Key.
Kind	Defines values for Kind. KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports. Known values supported by the service sdk designer bot function azurebot
MsaAppType	Defines values for MsaAppType. KnownMsaAppType can be used interchangeably with MsaAppType, this enum contains the known values that the service supports. Known values supported by the service UserAssignedMSI SingleTenant MultiTenant
OperationResultStatus	Defines values for OperationResultStatus. KnownOperationResultStatus can be used interchangeably with OperationResultStatus, this enum contains the known values that the service supports. Known values supported by the service Canceled Succeeded Failed Requested Running
OperationResultsGetResponse	Contains response data for the get operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
PrivateEndpointConnectionsCreateResponse	Contains response data for the create operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListResponse	Contains response data for the list operation.
PrivateEndpointServiceConnectionStatus	Defines values for PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected
PrivateLinkResourcesListByBotResourceResponse	Contains response data for the listByBotResource operation.
PublicNetworkAccess	Defines values for PublicNetworkAccess. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
QnAMakerEndpointKeysGetResponse	Contains response data for the get operation.
RegenerateKeysChannelName	Defines values for RegenerateKeysChannelName.
SkuName	Defines values for SkuName. KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports. Known values supported by the service F0 S1
SkuTier	Defines values for SkuTier. KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports. Known values supported by the service Free Standard

Enums

KnownKind	Known values of Kind that the service accepts.
KnownMsaAppType	Known values of MsaAppType that the service accepts.
KnownOperationResultStatus	Known values of OperationResultStatus that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownSkuName	Known values of SkuName that the service accepts.
KnownSkuTier	Known values of SkuTier that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.