CosmosDbService class

Package:

botframework-config

Warning

This API is now deprecated.

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

Defines a CosmosDB service connection.

Extends

AzureService

Constructors

CosmosDbService(ICosmosDBService)

Creates a new CosmosDBService instance.

Properties

collection	Collection name.
database	Database name.
endpoint	Endpoint/uri for CosmosDB.
key	Key for accessing CosmosDB.

Inherited Properties

id	Unique Id for the service.
name	Friendly name for the service.
resourceGroup	Resource group for azure.
serviceName	Name of the service.
subscriptionId	Subscription ID for azure.
tenantId	Tenant ID for azure.
type

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.

Inherited Methods

toJSON()

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

Constructor Details

CosmosDbService(ICosmosDBService)

Creates a new CosmosDBService instance.

new CosmosDbService(source?: ICosmosDBService)

Parameters

source

ICosmosDBService

(Optional) JSON based service definition.

Property Details

collection

Collection name.

collection: string

Property Value

string

database

Database name.

database: string

Property Value

string

endpoint

Endpoint/uri for CosmosDB.

endpoint: string

Property Value

string

key

Key for accessing CosmosDB.

key: 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

resourceGroup

Resource group for azure.

resourceGroup: string

Property Value

string

Inherited From AzureService.resourceGroup

serviceName

Name of the service.

serviceName: string

Property Value

string

Inherited From AzureService.serviceName

subscriptionId

Subscription ID for azure.

subscriptionId: string

Property Value

string

Inherited From AzureService.subscriptionId

tenantId

Tenant ID for azure.

tenantId: string

Property Value

string

Inherited From AzureService.tenantId

type

type?: ServiceTypes

Property Value

ServiceTypes

Inherited From ConnectedService.type

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.

decryptString

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

Function called to decrypt an individual value.

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.

encryptString

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

Function called to encrypt an individual value.

Inherited Method Details

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