EnterpriseChannels | @azure/arm-botservice

Class representing a EnterpriseChannels.

Hierarchy

EnterpriseChannels

Index

Constructors

constructor

Methods

Constructors

constructor

new EnterpriseChannels(client: AzureBotServiceContext): EnterpriseChannels

- Defined in operations/enterpriseChannels.ts:20
Create a EnterpriseChannels.

Parameters
- client: AzureBotServiceContext
  
  Reference to the service client.
Returns EnterpriseChannels

Methods

beginCreate

beginCreate(resourceGroupName: string, resourceName: string, parameters: EnterpriseChannel, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/enterpriseChannels.ts:166
Creates an Enterprise Channel.

Parameters
- resourceGroupName: string
  
  The name of the Bot resource group in the user subscription.
- resourceName: string
  
  The name of the Bot resource.
- parameters: EnterpriseChannel
  
  The parameters to provide for the new Enterprise Channel.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/enterpriseChannels.ts:203
Deletes an Enterprise Channel from the resource group

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<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdate

beginUpdate(resourceGroupName: string, resourceName: string, options?: Models.EnterpriseChannelsBeginUpdateOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/enterpriseChannels.ts:185
Updates an Enterprise Channel.

Parameters
- resourceGroupName: string
  
  The name of the Bot resource group in the user subscription.
- resourceName: string
  
  The name of the Bot resource.
- Optional options: Models.EnterpriseChannelsBeginUpdateOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

checkNameAvailability

checkNameAvailability(parameters: EnterpriseChannelCheckNameAvailabilityRequest, options?: msRest.RequestOptionsBase): Promise<Models.EnterpriseChannelsCheckNameAvailabilityResponse>
checkNameAvailability(parameters: EnterpriseChannelCheckNameAvailabilityRequest, callback: msRest.ServiceCallback<EnterpriseChannelCheckNameAvailabilityResponse>): void
checkNameAvailability(parameters: EnterpriseChannelCheckNameAvailabilityRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EnterpriseChannelCheckNameAvailabilityResponse>): void

- Defined in operations/enterpriseChannels.ts:37
Check whether an Enterprise Channel name is available.

Parameters
- parameters: EnterpriseChannelCheckNameAvailabilityRequest
  
  The parameters to provide for the Enterprise Channel check name availability request.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.EnterpriseChannelsCheckNameAvailabilityResponse>

Promise<Models.EnterpriseChannelsCheckNameAvailabilityResponse>
- Defined in operations/enterpriseChannels.ts:43
Parameters
- parameters: EnterpriseChannelCheckNameAvailabilityRequest
  
  The parameters to provide for the Enterprise Channel check name availability request.
- callback: msRest.ServiceCallback<EnterpriseChannelCheckNameAvailabilityResponse>
  
  The callback
Returns void
- Defined in operations/enterpriseChannels.ts:50
Parameters
- parameters: EnterpriseChannelCheckNameAvailabilityRequest
  
  The parameters to provide for the Enterprise Channel check name availability request.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EnterpriseChannelCheckNameAvailabilityResponse>
  
  The callback
Returns void

create

create(resourceGroupName: string, resourceName: string, parameters: EnterpriseChannel, options?: msRest.RequestOptionsBase): Promise<Models.EnterpriseChannelsCreateResponse>

- Defined in operations/enterpriseChannels.ts:97
Creates an Enterprise Channel.

Parameters
- resourceGroupName: string
  
  The name of the Bot resource group in the user subscription.
- resourceName: string
  
  The name of the Bot resource.
- parameters: EnterpriseChannel
  
  The parameters to provide for the new Enterprise Channel.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.EnterpriseChannelsCreateResponse>

Promise<Models.EnterpriseChannelsCreateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/enterpriseChannels.ts:121
Deletes an Enterprise Channel from the resource group

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<msRest.RestResponse>

Promise<msRest.RestResponse>

get

get(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.EnterpriseChannelsGetResponse>
get(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<EnterpriseChannel>): void
get(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EnterpriseChannel>): void

- Defined in operations/enterpriseChannels.ts:133
Returns an Enterprise Channel specified by the parameters.

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.EnterpriseChannelsGetResponse>

Promise<Models.EnterpriseChannelsGetResponse>
- Defined in operations/enterpriseChannels.ts:139
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<EnterpriseChannel>
  
  The callback
Returns void
- Defined in operations/enterpriseChannels.ts:146
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<EnterpriseChannel>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.EnterpriseChannelsListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<EnterpriseChannelResponseList>): void
listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EnterpriseChannelResponseList>): void

- Defined in operations/enterpriseChannels.ts:67
Returns all the resources of a particular type belonging to a resource group.

Parameters
- resourceGroupName: string
  
  The name of the Bot resource group in the user subscription.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.EnterpriseChannelsListByResourceGroupResponse>

Promise<Models.EnterpriseChannelsListByResourceGroupResponse>
- Defined in operations/enterpriseChannels.ts:72
Parameters
- resourceGroupName: string
  
  The name of the Bot resource group in the user subscription.
- callback: msRest.ServiceCallback<EnterpriseChannelResponseList>
  
  The callback
Returns void
- Defined in operations/enterpriseChannels.ts:78
Parameters
- resourceGroupName: string
  
  The name of the Bot resource group in the user subscription.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EnterpriseChannelResponseList>
  
  The callback
Returns void

listByResourceGroupNext

listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.EnterpriseChannelsListByResourceGroupNextResponse>
listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<EnterpriseChannelResponseList>): void
listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EnterpriseChannelResponseList>): void

- Defined in operations/enterpriseChannels.ts:220
Returns all the resources of a particular type belonging to a resource group.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.EnterpriseChannelsListByResourceGroupNextResponse>

Promise<Models.EnterpriseChannelsListByResourceGroupNextResponse>
- Defined in operations/enterpriseChannels.ts:225
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<EnterpriseChannelResponseList>
  
  The callback
Returns void
- Defined in operations/enterpriseChannels.ts:231
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EnterpriseChannelResponseList>
  
  The callback
Returns void

update

update(resourceGroupName: string, resourceName: string, options?: Models.EnterpriseChannelsUpdateOptionalParams): Promise<Models.EnterpriseChannelsUpdateResponse>

- Defined in operations/enterpriseChannels.ts:109
Updates an Enterprise Channel.

Parameters
- resourceGroupName: string
  
  The name of the Bot resource group in the user subscription.
- resourceName: string
  
  The name of the Bot resource.
- Optional options: Models.EnterpriseChannelsUpdateOptionalParams
Returns Promise<Models.EnterpriseChannelsUpdateResponse>

Promise<Models.EnterpriseChannelsUpdateResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: AzureBotServiceContext

Returns EnterpriseChannels

Methods

beginCreate

Parameters

resourceGroupName: string

resourceName: string

parameters: EnterpriseChannel

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

resourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginUpdate

Parameters

resourceGroupName: string

resourceName: string

Optional options: Models.EnterpriseChannelsBeginUpdateOptionalParams

Returns Promise<msRestAzure.LROPoller>

checkNameAvailability

Parameters

parameters: EnterpriseChannelCheckNameAvailabilityRequest

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.EnterpriseChannelsCheckNameAvailabilityResponse>

Parameters

parameters: EnterpriseChannelCheckNameAvailabilityRequest

callback: msRest.ServiceCallback<EnterpriseChannelCheckNameAvailabilityResponse>

Returns void

Parameters

parameters: EnterpriseChannelCheckNameAvailabilityRequest

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<EnterpriseChannelCheckNameAvailabilityResponse>

Returns void

create

Parameters

resourceGroupName: string

resourceName: string

parameters: EnterpriseChannel

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.EnterpriseChannelsCreateResponse>

deleteMethod

Parameters

resourceGroupName: string

resourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

get

Parameters

resourceGroupName: string

resourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.EnterpriseChannelsGetResponse>

Parameters

resourceGroupName: string

resourceName: string

callback: msRest.ServiceCallback<EnterpriseChannel>

Returns void

Parameters

resourceGroupName: string

resourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<EnterpriseChannel>

Returns void

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.EnterpriseChannelsListByResourceGroupResponse>

Parameters

resourceGroupName: string