CosmosDBAccount Class

Creates a new CosmosDBAccount.

Describes the types of schema for analytical storage.

Describes the ServerVersion of an a MongoDB account.

The object representing the policy for taking backups on an account. Please note Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountBackupPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include Azure.ResourceManager.CosmosDB.Models.ContinuousModeBackupPolicy and Azure.ResourceManager.CosmosDB.Models.PeriodicModeBackupPolicy.

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

List of Cosmos DB capabilities for the account.

The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

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

The consistency policy for the Cosmos DB account.

The CORS policy for the Cosmos DB database account.

Enum to indicate the mode of account creation.

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

The offer type for the database.

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.

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

Declares explicit dependencies on other resources.

Declares explicit dependencies on other resources.

Describe the level of detail with which queries are to be logged.

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

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

The connection endpoint for the Cosmos DB database account.

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.

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

Enables the cassandra connector on the Cosmos DB C* account.

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

Enables the account to write in multiple locations.

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

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

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

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

Gets the Id.

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

Identity for the resource.

A unique identifier assigned to the database account.

List of IpRules.

Flag to indicate whether to enable storage analytics.

Gets whether this is referencing an existing resource or we're defining a new resource.

Gets whether this is referencing an existing resource or we're defining a new resource.

Flag to indicate whether Free Tier is enabled.

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

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.

The URI of the key vault.

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

Gets or sets the Location.

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

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.

Cosmos DB database account name.

Indicates what services are allowed to bypass firewall checks.

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

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

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

Whether requests from Public Network are allowed.

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

Gets the type of the resource.

Gets the type of the resource.

Gets or sets the version of the resource.

Gets or sets the version of the resource.

Parameters to indicate the information about the restore.

Gets the SystemData.

Gets or sets the Tags.

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

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

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

Compile the resource into a set of Bicep statements.

Compile the resource into a set of Bicep statements.

Creates a role assignment for a principal that grants access to this CosmosDBAccount.

Creates a role assignment for a user-assigned identity that grants access to this CosmosDBAccount.

Define all the provisionable properties of CosmosDBAccount.

Creates a reference to an existing CosmosDBAccount.

Get access keys for this CosmosDBAccount resource.

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

Initialize this construct.

Set this construct to represent the result of an expression. This is primarily meant to be called via FromExpression static methods on specific resources or constructs.

Resolve any resources or properties that were not explicitly specified.

Resolve any resources or properties that were not explicitly specified.

Resolve any resources or properties that were not explicitly specified.

Resolve any resources or properties that were not explicitly specified.

Validate the presence of any required members.

Validate the presence of any required members.

Validate the presence of any required members.

Validate the presence of any required members.

Assign a value to this property.

Compile this value to a Bicep expression.

Gets the expression for this value if it's not a literal.

Gets whether this value is unset or empty.

Tracks whether this is an output only property.

Tracks whether this property is required.

Tracks whether this contains a secure value.

Gets the kind of this value (a literal value, an expression, or it's unset).

Get the value of this expression, if it's literal.

Gets information about where this value was defined.

Make this value readonly.

Gets information about where this value was assigned from.