DatabaseAccount class

Package:

@azure/cosmos

Represents a DatabaseAccount in the Azure Cosmos DB database service.

Constructors

DatabaseAccount({[key: string]: any}, CosmosHeaders)

Properties

consistencyPolicy	Gets the UserConsistencyPolicy settings.
ConsistencyPolicy	Gets the UserConsistencyPolicy settings.
currentMediaStorageUsageInMB	Current attachment content (media) usage in MBs (Retrieved from gateway ) Value is returned from cached information updated periodically and is not guaranteed to be real time.
CurrentMediaStorageUsageInMB	Current attachment content (media) usage in MBs (Retrieved from gateway ) Value is returned from cached information updated periodically and is not guaranteed to be real time.
databasesLink	The self-link for Databases in the databaseAccount.
DatabasesLink	The self-link for Databases in the databaseAccount.
enableMultipleWritableLocations
maxMediaStorageUsageInMB	Attachment content (media) storage quota in MBs ( Retrieved from gateway ).
MaxMediaStorageUsageInMB	Attachment content (media) storage quota in MBs ( Retrieved from gateway ).
mediaLink	The self-link for Media in the databaseAccount.
MediaLink	The self-link for Media in the databaseAccount.
readableLocations	The list of readable locations for a geo-replicated database account.
writableLocations	The list of writable locations for a geo-replicated database account.

Constructor Details

DatabaseAccount({[key: string]: any}, CosmosHeaders)

new DatabaseAccount(body: {[key: string]: any}, headers: CosmosHeaders)

Parameters

body

{[key: string]: any}

headers

CosmosHeaders

Property Details

consistencyPolicy

Gets the UserConsistencyPolicy settings.

consistencyPolicy: ConsistencyLevel

Property Value

ConsistencyLevel

ConsistencyPolicy

Gets the UserConsistencyPolicy settings.

ConsistencyLevel ConsistencyPolicy

Property Value

ConsistencyLevel

currentMediaStorageUsageInMB

Current attachment content (media) usage in MBs (Retrieved from gateway )

Value is returned from cached information updated periodically and is not guaranteed to be real time.

currentMediaStorageUsageInMB: number

Property Value

number

CurrentMediaStorageUsageInMB

Current attachment content (media) usage in MBs (Retrieved from gateway )

Value is returned from cached information updated periodically and is not guaranteed to be real time.

number CurrentMediaStorageUsageInMB

Property Value

number

databasesLink

The self-link for Databases in the databaseAccount.

databasesLink: string

Property Value

string

DatabasesLink

The self-link for Databases in the databaseAccount.

string DatabasesLink

Property Value

string

enableMultipleWritableLocations

enableMultipleWritableLocations: boolean

Property Value

boolean

maxMediaStorageUsageInMB

Attachment content (media) storage quota in MBs ( Retrieved from gateway ).

maxMediaStorageUsageInMB: number

Property Value

number

MaxMediaStorageUsageInMB

Attachment content (media) storage quota in MBs ( Retrieved from gateway ).

number MaxMediaStorageUsageInMB

Property Value

number

mediaLink

The self-link for Media in the databaseAccount.

mediaLink: string

Property Value

string

MediaLink

The self-link for Media in the databaseAccount.

string MediaLink

Property Value

string

readableLocations

The list of readable locations for a geo-replicated database account.

readableLocations: Location_2[]

Property Value

Location[]

writableLocations

The list of writable locations for a geo-replicated database account.

writableLocations: Location_2[]

Property Value

Location[]