DatabaseAccountUpdateParameters interface
Parameters for patching Azure Cosmos DB database account properties.
Properties
| analytical |
Analytical storage specific properties. |
| api |
API specific properties. Currently, supported only for MongoDB API. |
| backup |
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. |
| connector |
The cassandra connector offer type for the Cosmos DB database C* account. |
| consistency |
The consistency policy for the Cosmos DB account. |
| cors | The CORS policy for the Cosmos DB database account. |
| customer |
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. |
| default |
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. |
| disable |
Disable write operations on metadata resources (databases, containers, throughput) via account keys |
| disable |
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. |
| enable |
Flag to indicate whether to enable storage analytics. |
| enable |
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. |
| enable |
Flag to indicate enabling/disabling of Burst Capacity feature on the account |
| enable |
Enables the cassandra connector on the Cosmos DB C* account |
| enable |
Flag to indicate whether Free Tier is enabled. |
| enable |
Enables the account to write in multiple locations |
| enable |
Flag to indicate enabling/disabling of Partition Merge feature on the account |
| enable |
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account |
| identity | Identity for the resource. |
| ip |
List of IpRules. |
| is |
Flag to indicate whether to enable/disable Virtual Network ACL rules. |
| keys |
This property is ignored during the update 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. |
| key |
The URI of the key vault |
| location | The location of the resource group to which the resource belongs. |
| locations | An array that contains the georeplication locations enabled for the Cosmos DB account. |
| minimal |
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. |
| network |
Indicates what services are allowed to bypass firewall checks. |
| network |
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
| public |
Whether requests from Public Network are allowed |
| 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". |
| virtual |
List of Virtual Network ACL rules configured for the Cosmos DB account. |
Property Details
analyticalStorageConfiguration
Analytical storage specific properties.
analyticalStorageConfiguration?: AnalyticalStorageConfigurationProperty Value
apiProperties
API specific properties. Currently, supported only for MongoDB API.
apiProperties?: ApiPropertiesProperty Value
backupPolicy
The object representing the policy for taking backups on an account.
backupPolicy?: BackupPolicyUnionProperty Value
capabilities
List of Cosmos DB capabilities for the account
capabilities?: Capability[]Property Value
capacity
The object that represents all properties related to capacity enforcement on an account.
capacity?: CapacityProperty Value
connectorOffer
The cassandra connector offer type for the Cosmos DB database C* account.
connectorOffer?: stringProperty Value
string
consistencyPolicy
The consistency policy for the Cosmos DB account.
consistencyPolicy?: ConsistencyPolicyProperty Value
cors
customerManagedKeyStatus
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
customerManagedKeyStatus?: stringProperty Value
string
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?: stringProperty Value
string
disableKeyBasedMetadataWriteAccess
Disable write operations on metadata resources (databases, containers, throughput) via account keys
disableKeyBasedMetadataWriteAccess?: booleanProperty Value
boolean
disableLocalAuth
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
disableLocalAuth?: booleanProperty Value
boolean
enableAnalyticalStorage
Flag to indicate whether to enable storage analytics.
enableAnalyticalStorage?: booleanProperty 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?: booleanProperty Value
boolean
enableBurstCapacity
Flag to indicate enabling/disabling of Burst Capacity feature on the account
enableBurstCapacity?: booleanProperty Value
boolean
enableCassandraConnector
Enables the cassandra connector on the Cosmos DB C* account
enableCassandraConnector?: booleanProperty Value
boolean
enableFreeTier
Flag to indicate whether Free Tier is enabled.
enableFreeTier?: booleanProperty Value
boolean
enableMultipleWriteLocations
Enables the account to write in multiple locations
enableMultipleWriteLocations?: booleanProperty Value
boolean
enablePartitionMerge
Flag to indicate enabling/disabling of Partition Merge feature on the account
enablePartitionMerge?: booleanProperty Value
boolean
enablePerRegionPerPartitionAutoscale
Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account
enablePerRegionPerPartitionAutoscale?: booleanProperty Value
boolean
identity
ipRules
isVirtualNetworkFilterEnabled
Flag to indicate whether to enable/disable Virtual Network ACL rules.
isVirtualNetworkFilterEnabled?: booleanProperty Value
boolean
keysMetadata
This property is ignored during the update 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?: DatabaseAccountKeysMetadataProperty Value
keyVaultKeyUri
The URI of the key vault
keyVaultKeyUri?: stringProperty Value
string
location
The location of the resource group to which the resource belongs.
location?: stringProperty 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?: stringProperty Value
string
networkAclBypass
Indicates what services are allowed to bypass firewall checks.
networkAclBypass?: NetworkAclBypassProperty Value
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?: stringProperty Value
string
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}
virtualNetworkRules
List of Virtual Network ACL rules configured for the Cosmos DB account.
virtualNetworkRules?: VirtualNetworkRule[]