AzureService class

Package:

botframework-config

Warning

This API is now deprecated.

See https://aka.ms/bot-file-basics for more information.

Base class for all azure service definitions.

Extends

ConnectedService

Constructors

AzureService(IAzureService, ServiceTypes)

Creates a new AzureService instance.

Properties

resourceGroup	Resource group for azure.
serviceName	Name of the service.
subscriptionId	Subscription ID for azure.
tenantId	Tenant ID for azure.

Inherited Properties

id	Unique Id for the service.
name	Friendly name for the service.
type

Inherited Methods

decrypt(string, (value: string, secret: string) => string)	Decrypt properties on this service.
encrypt(string, (value: string, secret: string) => string)	Encrypt properties on this service.
toJSON()	Creates a JSON based version of the model for saving to disk.

Constructor Details

AzureService(IAzureService, ServiceTypes)

Creates a new AzureService instance.

new AzureService(source: IAzureService, type: ServiceTypes)

Parameters

source

IAzureService

(Optional) JSON based service definition.

type

ServiceTypes

Type of service being defined.

Property Details

resourceGroup

Resource group for azure.

resourceGroup: string

Property Value

string

serviceName

Name of the service.

serviceName: string

Property Value

string

subscriptionId

Subscription ID for azure.

subscriptionId: string

Property Value

string

tenantId

Tenant ID for azure.

tenantId: string

Property Value

string

Inherited Property Details

id

Unique Id for the service.

id: string

Property Value

string

Inherited From ConnectedService.id

name

Friendly name for the service.

name: string

Property Value

string

Inherited From ConnectedService.name

type

type?: ServiceTypes

Property Value

ServiceTypes

Inherited From ConnectedService.type

Inherited Method Details

decrypt(string, (value: string, secret: string) => string)

Decrypt properties on this service.

function decrypt(_secret: string, _decryptString: (value: string, secret: string) => string)

Parameters

_secret

string

Secret to use to decrypt the keys in this service.

_decryptString

(value: string, secret: string) => string

Function called to decrypt an individual value.

Inherited From ConnectedService.decrypt

encrypt(string, (value: string, secret: string) => string)

Encrypt properties on this service.

function encrypt(_secret: string, _encryptString: (value: string, secret: string) => string)

Parameters

_secret

string

Secret to use to encrypt the keys in this service.

_encryptString

(value: string, secret: string) => string

Function called to encrypt an individual value.

Inherited From ConnectedService.encrypt

toJSON()

Creates a JSON based version of the model for saving to disk.

function toJSON(): IConnectedService

Returns

IConnectedService

An IConnectedService JSON.

Inherited From ConnectedService.toJSON