CosmosDbService class

Warning

This API is now obsolete.

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

Defines a CosmosDB service connection.

Extends

Constructors

CosmosDbService(ICosmosDBService)

Creates a new CosmosDBService instance.

Properties

collection

Collection name.

database

Database name.

endpoint

Endpoint/uri for CosmosDB.

id

Unique Id for the service.

key

Key for accessing CosmosDB.

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.

toJSON()

Returns 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

id

Unique Id for the service.

id: string

Property Value

string

key

Key for accessing CosmosDB.

key: string

Property Value

string

name

Friendly name for the service.

name: string

Property Value

string

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

type

type?: ServiceTypes

Property Value

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.

toJSON()

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

function toJSON()

Returns