pulumi-azure-native-kotlin/com.pulumi.azurenative.documentdb.kotlin.outputs/GetDatabaseAccountResult

GetDatabaseAccountResult

data class GetDatabaseAccountResult(val apiProperties: ApiPropertiesResponse? = null, val backupPolicy: Either<ContinuousModeBackupPolicyResponse, PeriodicModeBackupPolicyResponse>? = null, val capabilities: List<CapabilityResponse>? = null, val connectorOffer: String? = null, val consistencyPolicy: ConsistencyPolicyResponse? = null, val cors: List<CorsPolicyResponse>? = null, val databaseAccountOfferType: String, val defaultIdentity: String? = null, val disableKeyBasedMetadataWriteAccess: Boolean? = null, val documentEndpoint: String, val enableAnalyticalStorage: Boolean? = null, val enableAutomaticFailover: Boolean? = null, val enableCassandraConnector: Boolean? = null, val enableFreeTier: Boolean? = null, val enableMultipleWriteLocations: Boolean? = null, val failoverPolicies: List<FailoverPolicyResponse>, val id: String, val identity: ManagedServiceIdentityResponse? = null, val ipRules: List<IpAddressOrRangeResponse>? = null, val isVirtualNetworkFilterEnabled: Boolean? = null, val keyVaultKeyUri: String? = null, val kind: String? = null, val location: String? = null, val locations: List<LocationResponse>, val name: String, val networkAclBypass: String? = null, val networkAclBypassResourceIds: List<String>? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val readLocations: List<LocationResponse>, val tags: Map<String, String>? = null, val type: String, val virtualNetworkRules: List<VirtualNetworkRuleResponse>? = null, val writeLocations: List<LocationResponse>)

An Azure Cosmos DB database account.

Constructors

constructor(apiProperties: ApiPropertiesResponse? = null, backupPolicy: Either<ContinuousModeBackupPolicyResponse, PeriodicModeBackupPolicyResponse>? = null, capabilities: List<CapabilityResponse>? = null, connectorOffer: String? = null, consistencyPolicy: ConsistencyPolicyResponse? = null, cors: List<CorsPolicyResponse>? = null, databaseAccountOfferType: String, defaultIdentity: String? = null, disableKeyBasedMetadataWriteAccess: Boolean? = null, documentEndpoint: String, enableAnalyticalStorage: Boolean? = null, enableAutomaticFailover: Boolean? = null, enableCassandraConnector: Boolean? = null, enableFreeTier: Boolean? = null, enableMultipleWriteLocations: Boolean? = null, failoverPolicies: List<FailoverPolicyResponse>, id: String, identity: ManagedServiceIdentityResponse? = null, ipRules: List<IpAddressOrRangeResponse>? = null, isVirtualNetworkFilterEnabled: Boolean? = null, keyVaultKeyUri: String? = null, kind: String? = null, location: String? = null, locations: List<LocationResponse>, name: String, networkAclBypass: String? = null, networkAclBypassResourceIds: List<String>? = null, privateEndpointConnections: List<PrivateEndpointConnectionResponse>, provisioningState: String, publicNetworkAccess: String? = null, readLocations: List<LocationResponse>, tags: Map<String, String>? = null, type: String, virtualNetworkRules: List<VirtualNetworkRuleResponse>? = null, writeLocations: List<LocationResponse>)

Types

Companion

object Companion

Properties

apiProperties

val apiProperties: ApiPropertiesResponse? = null

API specific properties.

backupPolicy

val backupPolicy: Either<ContinuousModeBackupPolicyResponse, PeriodicModeBackupPolicyResponse>? = null

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

capabilities

val capabilities: List<CapabilityResponse>? = null

List of Cosmos DB capabilities for the account

connectorOffer

val connectorOffer: String? = null

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

consistencyPolicy

val consistencyPolicy: ConsistencyPolicyResponse? = null

The consistency policy for the Cosmos DB database account.

cors

val cors: List<CorsPolicyResponse>? = null

The CORS policy for the Cosmos DB database account.

databaseAccountOfferType

val databaseAccountOfferType: String

The offer type for the Cosmos DB database account. Default value: Standard.

defaultIdentity

val defaultIdentity: String? = null

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

val disableKeyBasedMetadataWriteAccess: Boolean? = null

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

documentEndpoint

val documentEndpoint: String

The connection endpoint for the Cosmos DB database account.

enableAnalyticalStorage

val enableAnalyticalStorage: Boolean? = null

Flag to indicate whether to enable storage analytics.

enableAutomaticFailover

val enableAutomaticFailover: Boolean? = null

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.

enableCassandraConnector

val enableCassandraConnector: Boolean? = null

Enables the cassandra connector on the Cosmos DB C* account

enableFreeTier

val enableFreeTier: Boolean? = null

Flag to indicate whether Free Tier is enabled.

enableMultipleWriteLocations

val enableMultipleWriteLocations: Boolean? = null

Enables the account to write in multiple locations

failoverPolicies

val failoverPolicies: List<FailoverPolicyResponse>

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

val id: String

The unique resource identifier of the ARM resource.

identity

val identity: ManagedServiceIdentityResponse? = null

Identity for the resource.

ipRules

val ipRules: List<IpAddressOrRangeResponse>? = null

List of IpRules.

isVirtualNetworkFilterEnabled

val isVirtualNetworkFilterEnabled: Boolean? = null

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

keyVaultKeyUri

val keyVaultKeyUri: String? = null

The URI of the key vault

kind

val kind: String? = null

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

location

val location: String? = null

The location of the resource group to which the resource belongs.

locations

val locations: List<LocationResponse>

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

name

val name: String

The name of the ARM resource.

networkAclBypass

val networkAclBypass: String? = null

Indicates what services are allowed to bypass firewall checks.

networkAclBypassResourceIds

val networkAclBypassResourceIds: List<String>? = null

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

privateEndpointConnections

val privateEndpointConnections: List<PrivateEndpointConnectionResponse>

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

provisioningState

val provisioningState: String

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

val publicNetworkAccess: String? = null

Whether requests from Public Network are allowed

readLocations

val readLocations: List<LocationResponse>

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