@azure/arm-botservice package

Classes

Interfaces

AcsChatChannel	AcsChat channel definition
AlexaChannel	Alexa channel definition
AlexaChannelProperties	The parameters to provide for the Alexa channel.
AzureBotServiceOptionalParams	Optional parameters for the client.
Bot	Bot resource definition
BotChannel	Bot channel resource definition
BotConnectionCreateOptionalParams	Optional parameters.
BotConnectionDeleteOptionalParams	Optional parameters.
BotConnectionGetOptionalParams	Optional parameters.
BotConnectionListByBotServiceOptionalParams	Optional parameters.
BotConnectionListServiceProvidersOptionalParams	Optional parameters.
BotConnectionListWithSecretsOptionalParams	Optional parameters.
BotConnectionOperations	Interface representing a BotConnection operations.
BotConnectionUpdateOptionalParams	Optional parameters.
BotProperties	The parameters to provide for the Bot.
BotsCreateOptionalParams	Optional parameters.
BotsDeleteOptionalParams	Optional parameters.
BotsGetCheckNameAvailabilityOptionalParams	Optional parameters.
BotsGetOptionalParams	Optional parameters.
BotsListByResourceGroupOptionalParams	Optional parameters.
BotsListOptionalParams	Optional parameters.
BotsOperations	Interface representing a Bots operations.
BotsUpdateOptionalParams	Optional parameters.
Channel	Channel definition
ChannelSettings	Channel settings definition
ChannelsCreateOptionalParams	Optional parameters.
ChannelsDeleteOptionalParams	Optional parameters.
ChannelsGetOptionalParams	Optional parameters.
ChannelsListByResourceGroupOptionalParams	Optional parameters.
ChannelsListWithKeysOptionalParams	Optional parameters.
ChannelsOperations	Interface representing a Channels operations.
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.
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
CreateEmailSignInUrlResponse	The ARM create email sign in url operation response.
CreateEmailSignInUrlResponseProperties	The set of properties specific to sign in url
DirectLineChannel	Direct Line channel definition
DirectLineChannelProperties	The parameters to provide for the Direct Line channel.
DirectLineOperations	Interface representing a DirectLine operations.
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.
EmailChannel	Email channel definition
EmailChannelProperties	The parameters to provide for the Email channel.
EmailCreateSignInUrlOptionalParams	Optional parameters.
EmailOperations	Interface representing a Email operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorBody	Bot Service error body.
ErrorDetail	The error detail.
ErrorModel	Bot Service error object.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FacebookChannel	Facebook channel definition
FacebookChannelProperties	The parameters to provide for the Facebook channel.
FacebookPage	A Facebook page for Facebook channel registration
HostSettingsGetOptionalParams	Optional parameters.
HostSettingsOperations	Interface representing a HostSettings operations.
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.
NetworkSecurityPerimeter	Information about Network Security Perimeter
NetworkSecurityPerimeterConfiguration	Network Security Perimeter configuration
NetworkSecurityPerimeterConfigurationProperties	Properties of Network Security Perimeter configuration
NetworkSecurityPerimeterConfigurationsGetOptionalParams	Optional parameters.
NetworkSecurityPerimeterConfigurationsListOptionalParams	Optional parameters.
NetworkSecurityPerimeterConfigurationsOperations	Interface representing a NetworkSecurityPerimeterConfigurations operations.
NetworkSecurityPerimeterConfigurationsReconcileOptionalParams	Optional parameters.
NspAccessRule	Information of Access Rule in a profile
NspAccessRuleProperties	Properties of Access Rule
NspAccessRulePropertiesSubscriptionsItem	Subscription for inbound rule
Omnichannel	Omnichannel channel definition
OperationDisplayInfo	The operation supported by Bot Service Management.
OperationEntity	The operations supported by Bot Service Management.
OperationResultsDescription	The properties indicating the operation result of an operation on a service.
OperationResultsGetOptionalParams	Optional parameters.
OperationResultsOperations	Interface representing a OperationResults operations.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OutlookChannel	Outlook channel definition
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionProperties	Properties of the PrivateEndpointConnectProperties.
PrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
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
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesListByBotResourceOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
Profile	Information about profile
ProvisioningIssue	Describes Provisioning issue for given Network Security Perimeter configuration
ProvisioningIssueProperties	Properties of Provisioning Issue
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QnAMakerEndpointKeysGetOptionalParams	Optional parameters.
QnAMakerEndpointKeysOperations	Interface representing a QnAMakerEndpointKeys operations.
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	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceAssociation	Information about resource association
RestorePollerOptions
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.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
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.
SystemData	Metadata pertaining to creation and last modification of the resource.
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

AccessMode	Access Mode of the resource association KnownAccessMode can be used interchangeably with AccessMode, this enum contains the known values that the service supports. Known values supported by the service Enforced Learning Audit
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ChannelName	Type of ChannelName
ChannelUnion	Alias for ChannelUnion
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
EmailChannelAuthMethod	Email channel auth method. 0 Password (Default); 1 Graph.
Key	Determines which key is to be regenerated
Kind	Indicates the type of bot service 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	Microsoft App Type for the bot 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
NspAccessRuleDirection	Direction of Access Rule KnownNspAccessRuleDirection can be used interchangeably with NspAccessRuleDirection, this enum contains the known values that the service supports. Known values supported by the service Inbound Outbound
OperationResultStatus	The status of the operation being performed. 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
PrivateEndpointConnectionProvisioningState	The current provisioning state. 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
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. 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
ProvisioningState	Type of ProvisioningState
PublicNetworkAccess	Whether the bot is in an isolated network 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 SecuredByPerimeter
RegenerateKeysChannelName	Type of RegenerateKeysChannelName
Severity	Provisioning state of Network Security Perimeter configuration propagation KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports. Known values supported by the service Warning Error
SkuName	The name of SKU. 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	Gets the sku tier. This is based on the SKU name. 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

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessMode	Access Mode of the resource association
KnownCreatedByType	The kind of entity that created the resource.
KnownKind	Indicates the type of bot service
KnownMsaAppType	Microsoft App Type for the bot
KnownNspAccessRuleDirection	Direction of Access Rule
KnownOperationResultStatus	The status of the operation being performed.
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicNetworkAccess	Whether the bot is in an isolated network
KnownSeverity	Provisioning state of Network Security Perimeter configuration propagation
KnownSkuName	The name of SKU.
KnownSkuTier	Gets the sku tier. This is based on the SKU name.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AzureBotService, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(AzureBotService, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AzureBotService, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: AzureBotService

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-botservice package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(AzureBotService, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback