DatabaseAccountGetResults interface

Reference

Package:: @azure/arm-cosmosdb

An Azure Cosmos DB database account.

Extends: ARMResourceProperties

Properties

analyticalStorageConfiguration	Analytical storage specific properties.
apiProperties	API specific properties.
backupPolicy	The object representing the policy for taking backups on an account.
capabilities	List of Cosmos DB capabilities for the account
capacity	The object that represents all properties related to capacity enforcement on an account.
connectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.
consistencyPolicy	The consistency policy for the Cosmos DB database 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 Cosmos DB database account. Default value: Standard. NOTE: This property will not be serialized. It can only be populated by the server.
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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
enableAnalyticalStorage	Flag to indicate whether to enable storage analytics.
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
enableFreeTier	Flag to indicate whether Free Tier is enabled.
enableMultipleWriteLocations	Enables the account to write in multiple locations
enablePartitionMerge	Flag to indicate enabling/disabling of Partition Merge feature on the account
failoverPolicies	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.
identity	Identity for the resource.
instanceId	A unique identifier assigned to the database account NOTE: This property will not be serialized. It can only be populated by the server.
ipRules	List of IpRules.
isVirtualNetworkFilterEnabled	Flag to indicate whether to enable/disable Virtual Network ACL rules.
keysMetadata	The object that represents the metadata for the Account Keys of the Cosmos DB account. NOTE: This property will not be serialized. It can only be populated by the server.
keyVaultKeyUri	The URI of the key vault
kind	Indicates the type of database account. This can only be set at database account creation.
locations	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.
minimalTlsVersion	Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess	Whether requests from Public Network are allowed
readLocations	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.
restoreParameters	Parameters to indicate the information about the restore.
systemData	The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	The unique resource identifier of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
location	The location of the resource group to which the resource belongs.
name	The name of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
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".
type	The type of Azure resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

analyticalStorageConfiguration

Analytical storage specific properties.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Property Value

AnalyticalStorageConfiguration

apiProperties

API specific properties.

apiProperties?: ApiProperties

Property Value

ApiProperties

backupPolicy

The object representing the policy for taking backups on an account.

backupPolicy?: BackupPolicyUnion

Property Value

BackupPolicyUnion

capabilities

List of Cosmos DB capabilities for the account

capabilities?: Capability[]

Property Value

Capability[]

capacity

The object that represents all properties related to capacity enforcement on an account.

capacity?: Capacity

Property Value

Capacity

connectorOffer

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

connectorOffer?: string

Property Value

string

consistencyPolicy

The consistency policy for the Cosmos DB database account.

consistencyPolicy?: ConsistencyPolicy

Property Value

ConsistencyPolicy

cors

The CORS policy for the Cosmos DB database account.

cors?: CorsPolicy[]

Property Value

CorsPolicy[]

createMode

Enum to indicate the mode of account creation.

createMode?: string

Property Value

string

customerManagedKeyStatus

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

customerManagedKeyStatus?: string

Property Value

string

databaseAccountOfferType

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.

databaseAccountOfferType?: "Standard"

Property Value

"Standard"

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.

defaultIdentity?: string

Property Value

string

disableKeyBasedMetadataWriteAccess

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

disableKeyBasedMetadataWriteAccess?: boolean

Property Value

boolean

disableLocalAuth

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

disableLocalAuth?: boolean

Property Value

boolean

documentEndpoint

The connection endpoint for the Cosmos DB database account. NOTE: This property will not be serialized. It can only be populated by the server.

documentEndpoint?: string

Property Value

string

enableAnalyticalStorage

Flag to indicate whether to enable storage analytics.

enableAnalyticalStorage?: boolean

Property Value

boolean

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.

enableAutomaticFailover?: boolean

Property Value

boolean

enableBurstCapacity

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

enableBurstCapacity?: boolean

Property Value

boolean

enableCassandraConnector

Enables the cassandra connector on the Cosmos DB C* account

enableCassandraConnector?: boolean

Property Value

boolean

enableFreeTier

Flag to indicate whether Free Tier is enabled.

enableFreeTier?: boolean

Property Value

boolean

enableMultipleWriteLocations

Enables the account to write in multiple locations

enableMultipleWriteLocations?: boolean

Property Value

boolean

enablePartitionMerge

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

enablePartitionMerge?: boolean

Property Value

boolean

failoverPolicies

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.

failoverPolicies?: FailoverPolicy[]

Property Value

FailoverPolicy[]

identity

Identity for the resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

instanceId

A unique identifier assigned to the database account NOTE: This property will not be serialized. It can only be populated by the server.

instanceId?: string

Property Value

string

ipRules

List of IpRules.

ipRules?: IpAddressOrRange[]

Property Value

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

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

isVirtualNetworkFilterEnabled?: boolean

Property Value

boolean

keysMetadata

The object that represents the metadata for the Account Keys of the Cosmos DB account. NOTE: This property will not be serialized. It can only be populated by the server.

keysMetadata?: DatabaseAccountKeysMetadata

Property Value

DatabaseAccountKeysMetadata

keyVaultKeyUri

The URI of the key vault

keyVaultKeyUri?: string

Property Value

string

kind

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

kind?: string

Property Value

string

locations

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.

locations?: Location_2[]

Property Value

Location[]

minimalTlsVersion

Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.

minimalTlsVersion?: string

Property Value

string

networkAclBypass

Indicates what services are allowed to bypass firewall checks.

networkAclBypass?: NetworkAclBypass

Property Value

NetworkAclBypass

networkAclBypassResourceIds

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

networkAclBypassResourceIds?: string[]

Property Value

string[]

privateEndpointConnections

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.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

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. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether requests from Public Network are allowed

publicNetworkAccess?: string

Property Value

string

readLocations

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.

readLocations?: Location_2[]

Property Value

Location[]

restoreParameters

Parameters to indicate the information about the restore.

restoreParameters?: RestoreParameters

Property Value

RestoreParameters

systemData

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

virtualNetworkRules

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

virtualNetworkRules?: VirtualNetworkRule[]

Property Value

VirtualNetworkRule[]

writeLocations

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.