DatabaseAccountUpdateParameters Class
Parameters for patching Azure Cosmos DB database account properties.
- Inheritance
-
DatabaseAccountUpdateParameters
Constructor
DatabaseAccountUpdateParameters(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, identity: Optional[_models.ManagedServiceIdentity] = None, consistency_policy: Optional[_models.ConsistencyPolicy] = None, locations: Optional[List[_models.Location]] = None, ip_rules: Optional[List[_models.IpAddressOrRange]] = None, is_virtual_network_filter_enabled: Optional[bool] = None, enable_automatic_failover: Optional[bool] = None, capabilities: Optional[List[_models.Capability]] = None, virtual_network_rules: Optional[List[_models.VirtualNetworkRule]] = None, enable_multiple_write_locations: Optional[bool] = None, enable_cassandra_connector: Optional[bool] = None, connector_offer: Optional[Union[str, _models.ConnectorOffer]] = None, disable_key_based_metadata_write_access: Optional[bool] = None, key_vault_key_uri: Optional[str] = None, default_identity: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, enable_free_tier: Optional[bool] = None, api_properties: Optional[_models.ApiProperties] = None, enable_analytical_storage: Optional[bool] = None, analytical_storage_configuration: Optional[_models.AnalyticalStorageConfiguration] = None, backup_policy: Optional[_models.BackupPolicy] = None, cors: Optional[List[_models.CorsPolicy]] = None, network_acl_bypass: Optional[Union[str, _models.NetworkAclBypass]] = None, network_acl_bypass_resource_ids: Optional[List[str]] = None, disable_local_auth: Optional[bool] = None, capacity: Optional[_models.Capacity] = None, **kwargs)Variables
A set of 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".
- location
- str
The location of the resource group to which the resource belongs.
- identity
- ManagedServiceIdentity
Identity for the resource.
- consistency_policy
- ConsistencyPolicy
The consistency policy for the Cosmos DB account.
An array that contains the georeplication locations enabled for the Cosmos DB account.
- ip_rules
- list[IpAddressOrRange]
List of IpRules.
- is_virtual_network_filter_enabled
- bool
Flag to indicate whether to enable/disable Virtual Network ACL rules.
- enable_automatic_failover
- bool
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.
- capabilities
- list[Capability]
List of Cosmos DB capabilities for the account.
- virtual_network_rules
- list[VirtualNetworkRule]
List of Virtual Network ACL rules configured for the Cosmos DB account.
- enable_multiple_write_locations
- bool
Enables the account to write in multiple locations.
- enable_cassandra_connector
- bool
Enables the cassandra connector on the Cosmos DB C* account.
- connector_offer
- str or ConnectorOffer
The cassandra connector offer type for the Cosmos DB database C* account. Known values are: "Small".
- disable_key_based_metadata_write_access
- bool
Disable write operations on metadata resources (databases, containers, throughput) via account keys.
- key_vault_key_uri
- str
The URI of the key vault.
- default_identity
- str
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.
- public_network_access
- str or PublicNetworkAccess
Whether requests from Public Network are allowed. Known values are: "Enabled", "Disabled".
- enable_free_tier
- bool
Flag to indicate whether Free Tier is enabled.
- api_properties
- ApiProperties
API specific properties. Currently, supported only for MongoDB API.
- enable_analytical_storage
- bool
Flag to indicate whether to enable storage analytics.
- analytical_storage_configuration
- AnalyticalStorageConfiguration
Analytical storage specific properties.
- backup_policy
- BackupPolicy
The object representing the policy for taking backups on an account.
- cors
- list[CorsPolicy]
The CORS policy for the Cosmos DB database account.
- network_acl_bypass
- str or NetworkAclBypass
Indicates what services are allowed to bypass firewall checks. Known values are: "None", "AzureServices".
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
- disable_local_auth
- bool
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- capacity
- Capacity
The object that represents all properties related to capacity enforcement on an account.
Feedback
Submit and view feedback for