CosmosDBAccount Class

Definition

Namespace:

Azure.Provisioning.CosmosDB

Assembly:

Azure.Provisioning.CosmosDB.dll

Package:

Azure.Provisioning.CosmosDB v1.0.0-beta.1

Source:

CosmosDBAccount.cs

CosmosDBAccount.

public class CosmosDBAccount : Azure.Provisioning.Primitives.Resource

type CosmosDBAccount = class
    inherit Resource

Public Class CosmosDBAccount
Inherits Resource

Inheritance

Object

Provisionable

ProvisioningConstruct

NamedProvisioningConstruct

Resource

CosmosDBAccount

Constructors

CosmosDBAccount(String, String)

Creates a new CosmosDBAccount.

Properties

AnalyticalStorageSchemaType	Describes the types of schema for analytical storage.
ApiServerVersion	Describes the ServerVersion of an a MongoDB account.
BackupPolicy	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.
Capabilities	List of Cosmos DB capabilities for the account.
CapacityTotalThroughputLimit	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.
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.
DefaultPriorityLevel	Enum to indicate default Priority Level of request for Priority Based Execution.
DependsOn	Declares explicit dependencies on other resources. (Inherited from Resource)
DiagnosticLogEnableFullTextQuery	Describe the level of detail with which queries are to be logged.
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.
DocumentEndpoint	The connection endpoint for the Cosmos DB database account.
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 Preview feature on the account.
EnableCassandraConnector	Enables the cassandra connector on the Cosmos DB C* account.
EnableMaterializedViews	Flag to indicate whether to enable MaterializedViews on the Cosmos DB account.
EnableMultipleWriteLocations	Enables the account to write in multiple locations.
EnablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account.
EnablePerRegionPerPartitionAutoscale	Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account.
EnablePriorityBasedExecution	Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account.
FailoverPolicies	An array that contains the regions ordered by their failover priorities.
Id	Gets the Id.
IdentifierName	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. (Inherited from NamedProvisioningConstruct)
Identity	Identity for the resource.
InstanceId	A unique identifier assigned to the database account.
IPRules	List of IpRules.
IsAnalyticalStorageEnabled	Flag to indicate whether to enable storage analytics.
IsExistingResource	Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from Resource)
IsFreeTierEnabled	Flag to indicate whether Free Tier is enabled.
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.
KeyVaultKeyUri	The URI of the key vault.
Kind	Indicates the type of database account. This can only be set at database account creation.
Location	Gets or sets the Location.
Locations	An array that contains the georeplication locations enabled for the Cosmos DB account.
MinimalTlsVersion	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.
Name	Cosmos DB database account name.
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.
PrivateEndpointConnections	List of Private Endpoint Connections configured for the Cosmos DB account.
ProvisioningState	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.
PublicNetworkAccess	Whether requests from Public Network are allowed.
ReadLocations	An array that contains of the read locations enabled for the Cosmos DB account.
ResourceType	Gets the type of the resource. (Inherited from Resource)
ResourceVersion	Gets or sets the version of the resource. (Inherited from Resource)
RestoreParameters	Parameters to indicate the information about the restore.
SystemData	Gets the SystemData.
Tags	Gets or sets the Tags.
VirtualNetworkRules	List of Virtual Network ACL rules configured for the Cosmos DB account.
WriteLocations	An array that contains the write location for the Cosmos DB account.

Methods

Build(ProvisioningContext)	Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from Resource)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from Resource)
CreateRoleAssignment(CosmosDBBuiltInRole, BicepValue<RoleManagementPrincipalType>, BicepValue<Guid>, String)	Creates a role assignment for a principal that grants access to this CosmosDBAccount.
CreateRoleAssignment(CosmosDBBuiltInRole, UserAssignedIdentity)	Creates a role assignment for a user-assigned identity that grants access to this CosmosDBAccount.
FromExisting(String, String)	Creates a reference to an existing CosmosDBAccount.
GetKeys()	Get access keys for this CosmosDBAccount resource.
GetResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
OverrideWithExpression(Expression)	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. (Inherited from ProvisioningConstruct)
Resolve(ProvisioningContext)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisioningConstruct)
Validate(ProvisioningContext)	Validate the presence of any required members. (Inherited from Resource)