pulumi-azure-native-kotlin/com.pulumi.azurenative.sql.kotlin.outputs/GetDatabaseResult

GetDatabaseResult

data class GetDatabaseResult(val autoPauseDelay: Int? = null, val availabilityZone: String? = null, val azureApiVersion: String, val catalogCollation: String? = null, val collation: String? = null, val creationDate: String, val currentBackupStorageRedundancy: String, val currentServiceObjectiveName: String, val currentSku: SkuResponse, val databaseId: String, val defaultSecondaryLocation: String, val earliestRestoreDate: String, val elasticPoolId: String? = null, val encryptionProtector: String? = null, val encryptionProtectorAutoRotation: Boolean? = null, val failoverGroupId: String, val federatedClientId: String? = null, val freeLimitExhaustionBehavior: String? = null, val highAvailabilityReplicaCount: Int? = null, val id: String, val identity: DatabaseIdentityResponse? = null, val isInfraEncryptionEnabled: Boolean, val isLedgerOn: Boolean? = null, val keys: Map<String, DatabaseKeyResponse>? = null, val kind: String, val licenseType: String? = null, val location: String, val maintenanceConfigurationId: String? = null, val managedBy: String, val manualCutover: Boolean? = null, val maxLogSizeBytes: Double, val maxSizeBytes: Double? = null, val minCapacity: Double? = null, val name: String, val pausedDate: String, val performCutover: Boolean? = null, val preferredEnclaveType: String? = null, val readScale: String? = null, val requestedBackupStorageRedundancy: String? = null, val requestedServiceObjectiveName: String, val resumedDate: String, val secondaryType: String? = null, val sku: SkuResponse? = null, val status: String, val tags: Map<String, String>? = null, val type: String, val useFreeLimit: Boolean? = null, val zoneRedundant: Boolean? = null)

A database resource.

Constructors

GetDatabaseResult

constructor(autoPauseDelay: Int? = null, availabilityZone: String? = null, azureApiVersion: String, catalogCollation: String? = null, collation: String? = null, creationDate: String, currentBackupStorageRedundancy: String, currentServiceObjectiveName: String, currentSku: SkuResponse, databaseId: String, defaultSecondaryLocation: String, earliestRestoreDate: String, elasticPoolId: String? = null, encryptionProtector: String? = null, encryptionProtectorAutoRotation: Boolean? = null, failoverGroupId: String, federatedClientId: String? = null, freeLimitExhaustionBehavior: String? = null, highAvailabilityReplicaCount: Int? = null, id: String, identity: DatabaseIdentityResponse? = null, isInfraEncryptionEnabled: Boolean, isLedgerOn: Boolean? = null, keys: Map<String, DatabaseKeyResponse>? = null, kind: String, licenseType: String? = null, location: String, maintenanceConfigurationId: String? = null, managedBy: String, manualCutover: Boolean? = null, maxLogSizeBytes: Double, maxSizeBytes: Double? = null, minCapacity: Double? = null, name: String, pausedDate: String, performCutover: Boolean? = null, preferredEnclaveType: String? = null, readScale: String? = null, requestedBackupStorageRedundancy: String? = null, requestedServiceObjectiveName: String, resumedDate: String, secondaryType: String? = null, sku: SkuResponse? = null, status: String, tags: Map<String, String>? = null, type: String, useFreeLimit: Boolean? = null, zoneRedundant: Boolean? = null)

Types

Companion

object Companion

Properties

autoPauseDelay

val autoPauseDelay: Int? = null

Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

availabilityZone

val availabilityZone: String? = null

Specifies the availability zone the database is pinned to.

azureApiVersion

val azureApiVersion: String

The Azure API version of the resource.

catalogCollation

val catalogCollation: String? = null

Collation of the metadata catalog.

collation

val collation: String? = null

The collation of the database.

creationDate

val creationDate: String

The creation date of the database (ISO8601 format).

currentBackupStorageRedundancy

val currentBackupStorageRedundancy: String

The storage account type used to store backups for this database.

currentServiceObjectiveName

val currentServiceObjectiveName: String

The current service level objective name of the database.

currentSku

val currentSku: SkuResponse

The name and tier of the SKU.

databaseId

val databaseId: String

The ID of the database.

defaultSecondaryLocation

val defaultSecondaryLocation: String

The default secondary region for this database.

earliestRestoreDate

val earliestRestoreDate: String

This records the earliest start date and time that restore is available for this database (ISO8601 format).

elasticPoolId

val elasticPoolId: String? = null

The resource identifier of the elastic pool containing this database.

encryptionProtector

val encryptionProtector: String? = null

The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.

encryptionProtectorAutoRotation

val encryptionProtectorAutoRotation: Boolean? = null

The flag to enable or disable auto rotation of database encryption protector AKV key.

failoverGroupId

val failoverGroupId: String

Failover Group resource identifier that this database belongs to.

federatedClientId

val federatedClientId: String? = null

The Client id used for cross tenant per database CMK scenario

freeLimitExhaustionBehavior

val freeLimitExhaustionBehavior: String? = null

Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.

highAvailabilityReplicaCount

val highAvailabilityReplicaCount: Int? = null

The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.

val id: String

Resource ID.

identity

val identity: DatabaseIdentityResponse? = null

The Azure Active Directory identity of the database.

isInfraEncryptionEnabled

val isInfraEncryptionEnabled: Boolean

Infra encryption is enabled for this database.

isLedgerOn

val isLedgerOn: Boolean? = null

Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

keys

val keys: Map<String, DatabaseKeyResponse>? = null

The resource ids of the user assigned identities to use

kind

val kind: String

Kind of database. This is metadata used for the Azure portal experience.

licenseType

val licenseType: String? = null

The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

location

val location: String

Resource location.

maintenanceConfigurationId

val maintenanceConfigurationId: String? = null

Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

managedBy

val managedBy: String

Resource that manages the database.

manualCutover

val manualCutover: Boolean? = null

Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

maxLogSizeBytes

val maxLogSizeBytes: Double

The max log size for this database.

maxSizeBytes

val maxSizeBytes: Double? = null

The max size of the database expressed in bytes.

minCapacity

val minCapacity: Double? = null

Minimal capacity that database will always have allocated, if not paused

name

val name: String

Resource name.

pausedDate

val pausedDate: String

The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.

performCutover

val performCutover: Boolean? = null

To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

preferredEnclaveType

val preferredEnclaveType: String? = null

Type of enclave requested on the database i.e. Default or VBS enclaves.

readScale

val readScale: String? = null

The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.

requestedBackupStorageRedundancy

val requestedBackupStorageRedundancy: String? = null

The storage account type to be used to store backups for this database.

requestedServiceObjectiveName

val requestedServiceObjectiveName: String

The requested service level objective name of the database.

resumedDate

val resumedDate: String

The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.

secondaryType

val secondaryType: String? = null

The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.

sku

val sku: SkuResponse? = null

The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

status

val status: String