Package version:

Interface Database

A database resource.

Hierarchy

Properties

autoPauseDelay? availabilityZone? catalogCollation? collation? createMode? creationDate? currentBackupStorageRedundancy? currentServiceObjectiveName? currentSku? databaseId? defaultSecondaryLocation? earliestRestoreDate? elasticPoolId? encryptionProtector? failoverGroupId? federatedClientId? highAvailabilityReplicaCount? id? identity? isInfraEncryptionEnabled? isLedgerOn? keys? kind? licenseType? location longTermRetentionBackupResourceId? maintenanceConfigurationId? managedBy? manualCutover? maxLogSizeBytes? maxSizeBytes? minCapacity? name? pausedDate? performCutover? preferredEnclaveType? readScale? recoverableDatabaseId? recoveryServicesRecoveryPointId? requestedBackupStorageRedundancy? requestedServiceObjectiveName? restorableDroppedDatabaseId? restorePointInTime? resumedDate? sampleName? secondaryType? sku? sourceDatabaseDeletionDate? sourceDatabaseId? sourceResourceId? status? tags? type? zoneRedundant?

Properties

Optional autoPauseDelay

autoPauseDelay?: number

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

Optional availabilityZone

availabilityZone?: string

Specifies the availability zone the database is pinned to.

Optional catalogCollation

catalogCollation?: string

Collation of the metadata catalog.

Optional collation

collation?: string

The collation of the database.

Optional createMode

createMode?: string

Specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

Optional Readonly creationDate

creationDate?: Date

The creation date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly currentBackupStorageRedundancy

currentBackupStorageRedundancy?: string

The storage account type used to store backups for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly currentServiceObjectiveName

currentServiceObjectiveName?: string

The current service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly currentSku

currentSku?: Sku

The name and tier of the SKU. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly databaseId

databaseId?: string

The ID of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly defaultSecondaryLocation

defaultSecondaryLocation?: string

The default secondary region for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly earliestRestoreDate

earliestRestoreDate?: Date

This records the earliest start date and time that restore is available for this database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

Optional elasticPoolId

elasticPoolId?: string

The resource identifier of the elastic pool containing this database.

Optional encryptionProtector

encryptionProtector?: string

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

Optional Readonly failoverGroupId

failoverGroupId?: string

Failover Group resource identifier that this database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional federatedClientId

federatedClientId?: string

The Client id used for cross tenant per database CMK scenario

Optional highAvailabilityReplicaCount

highAvailabilityReplicaCount?: number

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

Optional Readonly id

id?: string

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

identity?: DatabaseIdentity

The Azure Active Directory identity of the database.

Optional Readonly isInfraEncryptionEnabled

isInfraEncryptionEnabled?: boolean

Infra encryption is enabled for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isLedgerOn

isLedgerOn?: boolean

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.

Optional keys

keys?: {
    [propertyName: string]: DatabaseKey;
}

The resource ids of the user assigned identities to use

Type declaration

Optional Readonly kind

kind?: string

Kind of database. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

Optional licenseType

licenseType?: string

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

location: string

Resource location.

Optional longTermRetentionBackupResourceId

longTermRetentionBackupResourceId?: string

The resource identifier of the long term retention backup associated with create operation of this database.

Optional maintenanceConfigurationId

maintenanceConfigurationId?: string

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

Optional Readonly managedBy

managedBy?: string

Resource that manages the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional manualCutover

manualCutover?: boolean

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.

Optional Readonly maxLogSizeBytes

maxLogSizeBytes?: number

The max log size for this database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxSizeBytes

maxSizeBytes?: number

The max size of the database expressed in bytes.

Optional minCapacity

minCapacity?: number

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

Optional Readonly name

name?: string

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly pausedDate

pausedDate?: Date

The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. NOTE: This property will not be serialized. It can only be populated by the server.

Optional performCutover

performCutover?: boolean

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.

Optional preferredEnclaveType

preferredEnclaveType?: string

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

Optional readScale

readScale?: string

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.

Optional recoverableDatabaseId

recoverableDatabaseId?: string

The resource identifier of the recoverable database associated with create operation of this database.

Optional recoveryServicesRecoveryPointId

recoveryServicesRecoveryPointId?: string

The resource identifier of the recovery point associated with create operation of this database.

Optional requestedBackupStorageRedundancy

requestedBackupStorageRedundancy?: string

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

Optional Readonly requestedServiceObjectiveName

requestedServiceObjectiveName?: string

The requested service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional restorableDroppedDatabaseId

restorableDroppedDatabaseId?: string

The resource identifier of the restorable dropped database associated with create operation of this database.

Optional restorePointInTime

restorePointInTime?: Date

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

Optional Readonly resumedDate

resumedDate?: Date

The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sampleName

sampleName?: string

The name of the sample schema to apply when creating this database.

Optional secondaryType

secondaryType?: string

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

Optional sku

sku?: Sku

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:

az sql db list-editions -l <location> -o table

Get-AzSqlServerServiceObjective -Location <location>

Optional sourceDatabaseDeletionDate

sourceDatabaseDeletionDate?: Date

Specifies the time that the database was deleted.

Optional sourceDatabaseId

sourceDatabaseId?: string

The resource identifier of the source database associated with create operation of this database.

Optional sourceResourceId

sourceResourceId?: string

The resource identifier of the source associated with the create operation of this database.

This property is only supported for DataWarehouse edition and allows to restore across subscriptions.

When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover.

When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified.

When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool.

When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool.

When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

Optional Readonly status

status?: string

The status of the database. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags?: {
    [propertyName: string]: string;
}

Resource tags.

Type declaration

  • [propertyName: string]: string

Optional Readonly type

type?: string

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional zoneRedundant

zoneRedundant?: boolean

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

Settings

Member Visibility

Theme

Generated using TypeDoc