DatabaseAccountCreateUpdateParameters Class
Parameters to create and update Cosmos DB database accounts.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
- Inheritance
-
azure.mgmt.cosmosdb.models._models_py3.ARMResourcePropertiesDatabaseAccountCreateUpdateParameters
Constructor
DatabaseAccountCreateUpdateParameters(*, locations: List[_models.Location], location: str | None = None, tags: Dict[str, str] | None = None, kind: str | _models.DatabaseAccountKind | None = None, identity: _models.ManagedServiceIdentity | None = None, consistency_policy: _models.ConsistencyPolicy | None = None, ip_rules: List[_models.IpAddressOrRange] | None = None, is_virtual_network_filter_enabled: bool | None = None, enable_automatic_failover: bool | None = None, capabilities: List[_models.Capability] | None = None, virtual_network_rules: List[_models.VirtualNetworkRule] | None = None, enable_multiple_write_locations: bool | None = None, enable_cassandra_connector: bool | None = None, connector_offer: str | _models.ConnectorOffer | None = None, disable_key_based_metadata_write_access: bool | None = None, key_vault_key_uri: str | None = None, default_identity: str | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, enable_free_tier: bool | None = None, api_properties: _models.ApiProperties | None = None, enable_analytical_storage: bool | None = None, analytical_storage_configuration: _models.AnalyticalStorageConfiguration | None = None, create_mode: str | _models.CreateMode = 'Default', backup_policy: _models.BackupPolicy | None = None, cors: List[_models.CorsPolicy] | None = None, network_acl_bypass: str | _models.NetworkAclBypass | None = None, network_acl_bypass_resource_ids: List[str] | None = None, disable_local_auth: bool | None = None, restore_parameters: _models.RestoreParameters | None = None, capacity: _models.Capacity | None = None, enable_partition_merge: bool | None = None, minimal_tls_version: str | _models.MinimalTlsVersion | None = None, enable_burst_capacity: bool | None = None, customer_managed_key_status: str | None = None, **kwargs: Any)
Keyword-Only Parameters
Name | Description |
---|---|
location
|
The location of the resource group to which the resource belongs. |
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". |
kind
|
Indicates the type of database account. This can only be set at database account creation. Known values are: "GlobalDocumentDB", "MongoDB", and "Parse". |
identity
|
Identity for the resource. |
consistency_policy
|
The consistency policy for the Cosmos DB account. |
locations
|
An array that contains the georeplication locations enabled for the Cosmos DB account. Required. |
ip_rules
|
List of IpRules. |
is_virtual_network_filter_enabled
|
Flag to indicate whether to enable/disable Virtual Network ACL rules. |
enable_automatic_failover
|
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 of Cosmos DB capabilities for the account. |
virtual_network_rules
|
List of Virtual Network ACL rules configured for the Cosmos DB account. |
enable_multiple_write_locations
|
Enables the account to write in multiple locations. |
enable_cassandra_connector
|
Enables the cassandra connector on the Cosmos DB C* account. |
connector_offer
|
The cassandra connector offer type for the Cosmos DB database C* account. "Small" |
disable_key_based_metadata_write_access
|
Disable write operations on metadata resources (databases, containers, throughput) via account keys. |
key_vault_key_uri
|
The URI of the key vault. |
default_identity
|
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
|
Whether requests from Public Network are allowed. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". |
enable_free_tier
|
Flag to indicate whether Free Tier is enabled. |
api_properties
|
API specific properties. Currently, supported only for MongoDB API. |
enable_analytical_storage
|
Flag to indicate whether to enable storage analytics. |
analytical_storage_configuration
|
Analytical storage specific properties. |
create_mode
|
str or
CreateMode
Enum to indicate the mode of account creation. Known values are: "Default" and "Restore". Default value: Default
|
backup_policy
|
The object representing the policy for taking backups on an account. |
cors
|
The CORS policy for the Cosmos DB database account. |
network_acl_bypass
|
Indicates what services are allowed to bypass firewall checks. Known values are: "None" and "AzureServices". |
network_acl_bypass_resource_ids
|
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
disable_local_auth
|
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. |
restore_parameters
|
Parameters to indicate the information about the restore. |
capacity
|
The object that represents all properties related to capacity enforcement on an account. |
enable_partition_merge
|
Flag to indicate enabling/disabling of Partition Merge feature on the account. |
minimal_tls_version
|
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: "Tls", "Tls11", and "Tls12". |
enable_burst_capacity
|
Flag to indicate enabling/disabling of Burst Capacity feature on the account. |
customer_managed_key_status
|
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. |
Variables
Name | Description |
---|---|
id
|
The unique resource identifier of the ARM resource. |
name
|
The name of the ARM resource. |
type
|
The type of Azure resource. |
location
|
The location of the resource group to which the resource belongs. |
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". |
kind
|
Indicates the type of database account. This can only be set at database account creation. Known values are: "GlobalDocumentDB", "MongoDB", and "Parse". |
identity
|
Identity for the resource. |
consistency_policy
|
The consistency policy for the Cosmos DB account. |
locations
|
An array that contains the georeplication locations enabled for the Cosmos DB account. Required. |
database_account_offer_type
|
The offer type for the database. Required. Default value is "Standard". |
ip_rules
|
List of IpRules. |
is_virtual_network_filter_enabled
|
Flag to indicate whether to enable/disable Virtual Network ACL rules. |
enable_automatic_failover
|
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 of Cosmos DB capabilities for the account. |
virtual_network_rules
|
List of Virtual Network ACL rules configured for the Cosmos DB account. |
enable_multiple_write_locations
|
Enables the account to write in multiple locations. |
enable_cassandra_connector
|
Enables the cassandra connector on the Cosmos DB C* account. |
connector_offer
|
The cassandra connector offer type for the Cosmos DB database C* account. "Small" |
disable_key_based_metadata_write_access
|
Disable write operations on metadata resources (databases, containers, throughput) via account keys. |
key_vault_key_uri
|
The URI of the key vault. |
default_identity
|
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
|
Whether requests from Public Network are allowed. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". |
enable_free_tier
|
Flag to indicate whether Free Tier is enabled. |
api_properties
|
API specific properties. Currently, supported only for MongoDB API. |
enable_analytical_storage
|
Flag to indicate whether to enable storage analytics. |
analytical_storage_configuration
|
Analytical storage specific properties. |
create_mode
|
str or
CreateMode
Enum to indicate the mode of account creation. Known values are: "Default" and "Restore". |
backup_policy
|
The object representing the policy for taking backups on an account. |
cors
|
The CORS policy for the Cosmos DB database account. |
network_acl_bypass
|
Indicates what services are allowed to bypass firewall checks. Known values are: "None" and "AzureServices". |
network_acl_bypass_resource_ids
|
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
disable_local_auth
|
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. |
restore_parameters
|
Parameters to indicate the information about the restore. |
capacity
|
The object that represents all properties related to capacity enforcement on an account. |
keys_metadata
|
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. |
enable_partition_merge
|
Flag to indicate enabling/disabling of Partition Merge feature on the account. |
minimal_tls_version
|
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. Known values are: "Tls", "Tls11", and "Tls12". |
enable_burst_capacity
|
Flag to indicate enabling/disabling of Burst Capacity feature on the account. |
customer_managed_key_status
|
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. |
Attributes
database_account_offer_type
database_account_offer_type = 'Standard'
Azure SDK for Python