Package version
Analytical storage specific properties.
API specific properties.
The object representing the policy for taking backups on an account.
List of Cosmos DB capabilities for the account
The object that represents all properties related to capacity enforcement on an account.
The cassandra connector offer type for the Cosmos DB database C* account.
The consistency policy for the Cosmos DB database account.
The CORS policy for the Cosmos DB database account.
Enum to indicate the mode of account creation.
The offer type for the Cosmos DB database account. Default value: Standard. NOTE: This property will not be serialized. It can only be populated by the server.
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.
The Object representing the different Diagnostic log settings for the Cosmos DB Account.
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. NOTE: This property will not be serialized. It can only be populated by the server.
Flag to indicate whether to enable storage analytics.
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.
Enables the cassandra connector on the Cosmos DB C* account
Flag to indicate whether Free Tier is enabled.
Flag to indicate whether to enable MaterializedViews on the Cosmos DB account
Enables the account to write in multiple locations
An array that contains the regions ordered by their failover priorities. NOTE: This property will not be serialized. It can only be populated by the server.
The unique resource identifier of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
Identity for the resource.
A unique identifier assigned to the database account NOTE: This property will not be serialized. It can only be populated by the server.
List of IpRules.
Flag to indicate whether to enable/disable Virtual Network ACL rules.
The URI of the key vault
The object that represents the metadata for the Account Keys of the Cosmos DB account.
Indicates the type of database account. This can only be set at database account creation.
The location of the resource group to which the resource belongs.
An array that contains all of the locations enabled for the Cosmos DB account. NOTE: This property will not be serialized. It can only be populated by the server.
The name of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
Whether requests from Public Network are allowed
An array that contains of the read locations enabled for the Cosmos DB account. NOTE: This property will not be serialized. It can only be populated by the server.
Parameters to indicate the information about the restore.
The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
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".
The type of Azure resource. NOTE: This property will not be serialized. It can only be populated by the server.
List of Virtual Network ACL rules configured for the Cosmos DB account.
An array that contains the write location for the Cosmos DB account. NOTE: This property will not be serialized. It can only be populated by the server.
Generated using TypeDoc
An Azure Cosmos DB database account.