DatabaseAccountGetResults interface
An Azure Cosmos DB database account.
- Extends
Properties
analytical |
Analytical storage specific properties. |
api |
API specific properties. |
backup |
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. |
connector |
The cassandra connector offer type for the Cosmos DB database C* account. |
consistency |
The consistency policy for the Cosmos DB database account. |
cors | The CORS policy for the Cosmos DB database account. |
create |
Enum to indicate the mode of account creation. |
customer |
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance. |
database |
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. |
default |
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. |
disable |
Disable write operations on metadata resources (databases, containers, throughput) via account keys |
disable |
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. |
document |
The connection endpoint for the Cosmos DB database account. NOTE: This property will not be serialized. It can only be populated by the server. |
enable |
Flag to indicate whether to enable storage analytics. |
enable |
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. |
enable |
Flag to indicate enabling/disabling of Burst Capacity feature on the account |
enable |
Enables the cassandra connector on the Cosmos DB C* account |
enable |
Flag to indicate whether Free Tier is enabled. |
enable |
Enables the account to write in multiple locations |
enable |
Flag to indicate enabling/disabling of Partition Merge feature on the account |
failover |
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. |
instance |
A unique identifier assigned to the database account NOTE: This property will not be serialized. It can only be populated by the server. |
ip |
List of IpRules. |
is |
Flag to indicate whether to enable/disable Virtual Network ACL rules. |
keys |
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. |
key |
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. |
minimal |
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. |
network |
Indicates what services are allowed to bypass firewall checks. |
network |
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
private |
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. |
provisioning |
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. |
public |
Whether requests from Public Network are allowed |
read |
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. |
restore |
Parameters to indicate the information about the restore. |
system |
The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server. |
virtual |
List of Virtual Network ACL rules configured for the Cosmos DB account. |
write |
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
apiProperties
backupPolicy
The object representing the policy for taking backups on an account.
backupPolicy?: BackupPolicyUnion
Property Value
capabilities
List of Cosmos DB capabilities for the account
capabilities?: Capability[]
Property Value
capacity
The object that represents all properties related to capacity enforcement on an account.
capacity?: Capacity
Property Value
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
cors
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 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
identity
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
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
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
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
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
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
virtualNetworkRules
List of Virtual Network ACL rules configured for the Cosmos DB account.
virtualNetworkRules?: VirtualNetworkRule[]
Property Value
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.
writeLocations?: Location_2[]
Property Value
Location[]
Inherited Property Details
id
The unique resource identifier of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ARMResourceProperties.id
location
The location of the resource group to which the resource belongs.
location?: string
Property Value
string
Inherited From ARMResourceProperties.location
name
The name of the ARM resource. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ARMResourceProperties.name
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".
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From ARMResourceProperties.tags
type
The type of Azure resource. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ARMResourceProperties.type