DatabaseAccountGetProperties interface

Package:

@azure/arm-cosmosdb

Properties for the database account.

Properties

analyticalStorageConfiguration	Analytical storage specific properties.
apiProperties	API specific properties.
backupPolicy	The object representing the policy for taking backups on an account.
capabilities	List of Cosmos DB capabilities for the account
capacity	The object that represents all properties related to capacity enforcement on an account.
capacityMode	Indicates the capacityMode of the Cosmos DB account.
capacityModeChangeTransitionState	The object that represents the migration state for the CapacityMode of the Cosmos DB account.
connectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.
consistencyPolicy	The consistency policy for the Cosmos DB database account.
cors	The CORS policy for the Cosmos DB database account.
createMode	Enum to indicate the mode of account creation.
customerManagedKeyStatus	Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
databaseAccountOfferType	The offer type for the Cosmos DB database account. Default value: Standard.
defaultIdentity	The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
defaultPriorityLevel	Enum to indicate default Priority Level of request for Priority Based Execution.
diagnosticLogSettings	The Object representing the different Diagnostic log settings for the Cosmos DB Account.
disableKeyBasedMetadataWriteAccess	Disable write operations on metadata resources (databases, containers, throughput) via account keys
disableLocalAuth	Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
documentEndpoint	The connection endpoint for the Cosmos DB database account.
enableAllVersionsAndDeletesChangeFeed	Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account
enableAnalyticalStorage	Flag to indicate whether to enable storage analytics.
enableAutomaticFailover	Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
enableBurstCapacity	Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account
enableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account
enableFreeTier	Flag to indicate whether Free Tier is enabled.
enableMaterializedViews	Flag to indicate whether to enable MaterializedViews on the Cosmos DB account
enableMultipleWriteLocations	Enables the account to write in multiple locations
enablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account
enablePerRegionPerPartitionAutoscale	Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account
enablePriorityBasedExecution	Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account
failoverPolicies	An array that contains the regions ordered by their failover priorities.
instanceId	A unique identifier assigned to the database account
ipRules	List of IpRules.
isVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.
keysMetadata	The object that represents the metadata for the Account Keys of the Cosmos DB account.
keyVaultKeyUri	The URI of the key vault
keyVaultKeyUriVersion	The version of the Customer Managed Key currently being used by the account
locations	An array that contains all of the locations enabled for the Cosmos DB account.
minimalTlsVersion	Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.
networkAclBypass	Indicates what services are allowed to bypass firewall checks.
networkAclBypassResourceIds	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
privateEndpointConnections	List of Private Endpoint Connections configured for the Cosmos DB account.
provisioningState	The provisioning state of the resource.
publicNetworkAccess	Whether requests from Public Network are allowed
readLocations	An array that contains of the read locations enabled for the Cosmos DB account.
restoreParameters	Parameters to indicate the information about the restore.
throughputPoolDedicatedRUs	Total dedicated throughput (RU/s) for database account. Represents the sum of all manual provisioned throughput and all autoscale max RU/s across all shared throughput databases and dedicated throughput containers in the account for 1 region. READ ONLY.
throughputPoolMaxConsumableRUs	When this account is part of a fleetspace with throughput pooling enabled, this is the maximum additional throughput (RU/s) that can be consumed from the pool, summed across all shared throughput databases and dedicated throughput containers in the account for 1 region. READ ONLY.
virtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.
writeLocations	An array that contains the write location for the Cosmos DB account.

Property Details

analyticalStorageConfiguration

Analytical storage specific properties.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Property Value

AnalyticalStorageConfiguration

apiProperties

API specific properties.

apiProperties?: ApiProperties

Property Value

ApiProperties

backupPolicy

The object representing the policy for taking backups on an account.

backupPolicy?: BackupPolicyUnion

Property Value

BackupPolicyUnion

capabilities

List of Cosmos DB capabilities for the account

capabilities?: Capability[]

Property Value

Capability[]

capacity

The object that represents all properties related to capacity enforcement on an account.

capacity?: Capacity

Property Value

Capacity

capacityMode

Indicates the capacityMode of the Cosmos DB account.

capacityMode?: string

Property Value

string

capacityModeChangeTransitionState

The object that represents the migration state for the CapacityMode of the Cosmos DB account.

capacityModeChangeTransitionState?: CapacityModeChangeTransitionState

Property Value

CapacityModeChangeTransitionState

connectorOffer

The cassandra connector offer type for the Cosmos DB database C* account.

connectorOffer?: string

Property Value

string

consistencyPolicy

The consistency policy for the Cosmos DB database account.

consistencyPolicy?: ConsistencyPolicy

Property Value

ConsistencyPolicy

cors

The CORS policy for the Cosmos DB database account.

cors?: CorsPolicy[]

Property Value

CorsPolicy[]

createMode

Enum to indicate the mode of account creation.

createMode?: string

Property Value

string

customerManagedKeyStatus

Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.

customerManagedKeyStatus?: string

Property Value

string

databaseAccountOfferType

The offer type for the Cosmos DB database account. Default value: Standard.

databaseAccountOfferType?: "Standard"

Property Value

"Standard"

defaultIdentity

The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.

defaultIdentity?: string

Property Value

string

defaultPriorityLevel

Enum to indicate default Priority Level of request for Priority Based Execution.

defaultPriorityLevel?: string

Property Value

string

diagnosticLogSettings

The Object representing the different Diagnostic log settings for the Cosmos DB Account.

diagnosticLogSettings?: DiagnosticLogSettings

Property Value

DiagnosticLogSettings

disableKeyBasedMetadataWriteAccess

Disable write operations on metadata resources (databases, containers, throughput) via account keys

disableKeyBasedMetadataWriteAccess?: boolean

Property Value

boolean

disableLocalAuth

Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

disableLocalAuth?: boolean

Property Value

boolean

documentEndpoint

The connection endpoint for the Cosmos DB database account.

documentEndpoint?: string

Property Value

string

enableAllVersionsAndDeletesChangeFeed

Flag to indicate if All Versions and Deletes Change feed feature is enabled on the account

enableAllVersionsAndDeletesChangeFeed?: boolean

Property Value

boolean

enableAnalyticalStorage

Flag to indicate whether to enable storage analytics.

enableAnalyticalStorage?: boolean

Property Value

boolean

enableAutomaticFailover

Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

enableAutomaticFailover?: boolean

Property Value

boolean

enableBurstCapacity

Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account

enableBurstCapacity?: boolean

Property Value

boolean

enableCassandraConnector

Enables the cassandra connector on the Cosmos DB C* account

enableCassandraConnector?: boolean

Property Value

boolean

enableFreeTier

Flag to indicate whether Free Tier is enabled.

enableFreeTier?: boolean

Property Value

boolean

enableMaterializedViews

Flag to indicate whether to enable MaterializedViews on the Cosmos DB account

enableMaterializedViews?: boolean

Property Value

boolean

enableMultipleWriteLocations

Enables the account to write in multiple locations

enableMultipleWriteLocations?: boolean

Property Value

boolean

enablePartitionMerge

Flag to indicate enabling/disabling of Partition Merge feature on the account

enablePartitionMerge?: boolean

Property Value

boolean

enablePerRegionPerPartitionAutoscale

Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account

enablePerRegionPerPartitionAutoscale?: boolean

Property Value

boolean

enablePriorityBasedExecution

Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account

enablePriorityBasedExecution?: boolean

Property Value

boolean

failoverPolicies

An array that contains the regions ordered by their failover priorities.

failoverPolicies?: FailoverPolicy[]

Property Value

FailoverPolicy[]

instanceId

A unique identifier assigned to the database account

instanceId?: string

Property Value

string

ipRules

List of IpRules.

ipRules?: IpAddressOrRange[]

Property Value

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Flag to indicate whether to enable/disable Virtual Network ACL rules.

isVirtualNetworkFilterEnabled?: boolean

Property Value

boolean

keysMetadata

The object that represents the metadata for the Account Keys of the Cosmos DB account.

keysMetadata?: DatabaseAccountKeysMetadata

Property Value

DatabaseAccountKeysMetadata

keyVaultKeyUri

The URI of the key vault

keyVaultKeyUri?: string

Property Value

string

keyVaultKeyUriVersion

The version of the Customer Managed Key currently being used by the account

keyVaultKeyUriVersion?: string

Property Value

string

locations

An array that contains all of the locations enabled for the Cosmos DB account.

locations?: Location[]

Property Value

Location[]

minimalTlsVersion

Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.

minimalTlsVersion?: string

Property Value

string

networkAclBypass

Indicates what services are allowed to bypass firewall checks.

networkAclBypass?: NetworkAclBypass

Property Value

NetworkAclBypass

networkAclBypassResourceIds

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

networkAclBypassResourceIds?: string[]

Property Value

string[]

privateEndpointConnections

List of Private Endpoint Connections configured for the Cosmos DB account.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The provisioning state of the resource.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether requests from Public Network are allowed

publicNetworkAccess?: string

Property Value

string

readLocations

An array that contains of the read locations enabled for the Cosmos DB account.

readLocations?: Location[]

Property Value

Location[]

restoreParameters

Parameters to indicate the information about the restore.

restoreParameters?: RestoreParameters

Property Value

RestoreParameters

throughputPoolDedicatedRUs

Total dedicated throughput (RU/s) for database account. Represents the sum of all manual provisioned throughput and all autoscale max RU/s across all shared throughput databases and dedicated throughput containers in the account for 1 region. READ ONLY.

throughputPoolDedicatedRUs?: number

Property Value

number

throughputPoolMaxConsumableRUs

When this account is part of a fleetspace with throughput pooling enabled, this is the maximum additional throughput (RU/s) that can be consumed from the pool, summed across all shared throughput databases and dedicated throughput containers in the account for 1 region. READ ONLY.

throughputPoolMaxConsumableRUs?: number

Property Value

number

virtualNetworkRules

List of Virtual Network ACL rules configured for the Cosmos DB account.

virtualNetworkRules?: VirtualNetworkRule[]

Property Value

VirtualNetworkRule[]

writeLocations

An array that contains the write location for the Cosmos DB account.

writeLocations?: Location[]

Property Value

Location[]