DatabaseAccountCreateUpdateParameters interface

Package:

@azure/arm-cosmosdb

Parameters to create and update Cosmos DB database accounts.

Extends

ARMResourceProperties

Properties

analyticalStorageConfiguration	Analytical storage specific properties.
apiProperties	API specific properties. Currently, supported only for MongoDB API.
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.
connectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.
consistencyPolicy	The consistency policy for the Cosmos DB 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 database
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.
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.
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 feature on the account
enableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account
enableFreeTier	Flag to indicate whether Free Tier is enabled.
enableMultipleWriteLocations	Enables the account to write in multiple locations
enablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account
identity	Identity for the resource.
ipRules	List of IpRules.
isVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.
keysMetadata	This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account. NOTE: This property will not be serialized. It can only be populated by the server.
keyVaultKeyUri	The URI of the key vault
kind	Indicates the type of database account. This can only be set at database account creation.
locations	An array that contains the georeplication locations enabled for the Cosmos DB account.
minimalTlsVersion	Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs 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.
publicNetworkAccess	Whether requests from Public Network are allowed
restoreParameters	Parameters to indicate the information about the restore.
virtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.

Inherited Properties

id	The unique resource identifier of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
location	The location of the resource group to which the resource belongs.
name	The name of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	The type of Azure resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

analyticalStorageConfiguration

Analytical storage specific properties.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Property Value

AnalyticalStorageConfiguration

apiProperties

API specific properties. Currently, supported only for MongoDB API.

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

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 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 database

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

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

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

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

identity

Identity for the resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

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

This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account. NOTE: This property will not be serialized. It can only be populated by the server.

keysMetadata?: DatabaseAccountKeysMetadata

Property Value

DatabaseAccountKeysMetadata

keyVaultKeyUri

The URI of the key vault

keyVaultKeyUri?: string

Property Value

string

kind

Indicates the type of database account. This can only be set at database account creation.

kind?: string

Property Value

string

locations

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

locations: Location_2[]

Property Value

Location[]

minimalTlsVersion

Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs 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[]

publicNetworkAccess

Whether requests from Public Network are allowed

publicNetworkAccess?: string

Property Value

string

restoreParameters

Parameters to indicate the information about the restore.

restoreParameters?: RestoreParameters

Property Value

RestoreParameters

virtualNetworkRules

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

virtualNetworkRules?: VirtualNetworkRule[]

Property Value

VirtualNetworkRule[]

Inherited Property Details

id

The unique resource identifier of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ARMResourceProperties.id

location

The location of the resource group to which the resource belongs.

location?: string

Property Value

string

Inherited From ARMResourceProperties.location

name

The name of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ARMResourceProperties.name

tags

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ARMResourceProperties.tags

type

The type of Azure resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ARMResourceProperties.type