Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BotConnection

Package version

Class representing a BotConnection.

Hierarchy

  • BotConnection

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, options?: msRest.RequestOptionsBase): Promise<Models.BotConnectionCreateResponse>
  • create(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, callback: msRest.ServiceCallback<ConnectionSetting>): void
  • create(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionSetting>): void

  • Register a new Auth Connection for a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • parameters: ConnectionSetting

      The parameters to provide for creating the Connection Setting.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.BotConnectionCreateResponse>

    Promise<Models.BotConnectionCreateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • parameters: ConnectionSetting

      The parameters to provide for creating the Connection Setting.

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • parameters: ConnectionSetting

      The parameters to provide for creating the Connection Setting.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, resourceName: string, connectionName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, resourceName: string, connectionName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, resourceName: string, connectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a Connection Setting registration for a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, resourceName: string, connectionName: string, options?: msRest.RequestOptionsBase): Promise<Models.BotConnectionGetResponse>
  • get(resourceGroupName: string, resourceName: string, connectionName: string, callback: msRest.ServiceCallback<ConnectionSetting>): void
  • get(resourceGroupName: string, resourceName: string, connectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionSetting>): void

  • Get a Connection Setting registration for a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.BotConnectionGetResponse>

    Promise<Models.BotConnectionGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

listByBotService

  • listByBotService(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.BotConnectionListByBotServiceResponse>
  • listByBotService(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<ConnectionSettingResponseList>): void
  • listByBotService(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionSettingResponseList>): void

  • Returns all the Connection Settings registered to a particular BotService resource

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.BotConnectionListByBotServiceResponse>

    Promise<Models.BotConnectionListByBotServiceResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • callback: msRest.ServiceCallback<ConnectionSettingResponseList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ConnectionSettingResponseList>

      The callback

    Returns void

listByBotServiceNext

  • listByBotServiceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.BotConnectionListByBotServiceNextResponse>
  • listByBotServiceNext(nextPageLink: string, callback: msRest.ServiceCallback<ConnectionSettingResponseList>): void
  • listByBotServiceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionSettingResponseList>): void

  • Returns all the Connection Settings registered to a particular BotService resource

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.BotConnectionListByBotServiceNextResponse>

    Promise<Models.BotConnectionListByBotServiceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ConnectionSettingResponseList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ConnectionSettingResponseList>

      The callback

    Returns void

listServiceProviders

  • listServiceProviders(options?: msRest.RequestOptionsBase): Promise<Models.BotConnectionListServiceProvidersResponse>
  • listServiceProviders(callback: msRest.ServiceCallback<ServiceProviderResponseList>): void
  • listServiceProviders(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ServiceProviderResponseList>): void

listWithSecrets

  • listWithSecrets(resourceGroupName: string, resourceName: string, connectionName: string, options?: msRest.RequestOptionsBase): Promise<Models.BotConnectionListWithSecretsResponse>
  • listWithSecrets(resourceGroupName: string, resourceName: string, connectionName: string, callback: msRest.ServiceCallback<ConnectionSetting>): void
  • listWithSecrets(resourceGroupName: string, resourceName: string, connectionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionSetting>): void

  • Get a Connection Setting registration for a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.BotConnectionListWithSecretsResponse>

    Promise<Models.BotConnectionListWithSecretsResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

update

  • update(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, options?: msRest.RequestOptionsBase): Promise<Models.BotConnectionUpdateResponse>
  • update(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, callback: msRest.ServiceCallback<ConnectionSetting>): void
  • update(resourceGroupName: string, resourceName: string, connectionName: string, parameters: ConnectionSetting, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ConnectionSetting>): void

  • Updates a Connection Setting registration for a Bot Service

    Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • parameters: ConnectionSetting

      The parameters to provide for updating the Connection Setting.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.BotConnectionUpdateResponse>

    Promise<Models.BotConnectionUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • parameters: ConnectionSetting

      The parameters to provide for updating the Connection Setting.

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Bot resource group in the user subscription.

    • resourceName: string

      The name of the Bot resource.

    • connectionName: string

      The name of the Bot Service Connection Setting resource

    • parameters: ConnectionSetting

      The parameters to provide for updating the Connection Setting.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ConnectionSetting>

      The callback

    Returns void

Generated using TypeDoc