Share via


SqlDatabaseData Class

Definition

A class representing the SqlDatabase data model. A database resource.

public class SqlDatabaseData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Sql.SqlDatabaseData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Sql.SqlDatabaseData>
type SqlDatabaseData = class
    inherit TrackedResourceData
    interface IJsonModel<SqlDatabaseData>
    interface IPersistableModel<SqlDatabaseData>
Public Class SqlDatabaseData
Inherits TrackedResourceData
Implements IJsonModel(Of SqlDatabaseData), IPersistableModel(Of SqlDatabaseData)
Inheritance
Implements

Constructors

SqlDatabaseData(AzureLocation)

Initializes a new instance of SqlDatabaseData.

Properties

AutoPauseDelay

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

AvailabilityZone

Specifies the availability zone the database is pinned to.

CatalogCollation

Collation of the metadata catalog.

Collation

The collation of the database.

CreatedOn

The creation date of the database (ISO8601 format).

CreateMode

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.

CurrentBackupStorageRedundancy

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

CurrentServiceObjectiveName

The current service level objective name of the database.

CurrentSku

The name and tier of the SKU.

DatabaseId

The ID of the database.

DefaultSecondaryLocation

The default secondary region for this database.

EarliestRestoreOn

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

ElasticPoolId

The resource identifier of the elastic pool containing this database.

EncryptionProtector

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

EncryptionProtectorAutoRotation

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

FailoverGroupId

Failover Group resource identifier that this database belongs to.

FederatedClientId

The Client id used for cross tenant per database CMK scenario.

FreeLimitExhaustionBehavior

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

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.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Identity

The Azure Active Directory identity of the database.

IsInfraEncryptionEnabled

Infra encryption is enabled for this database.

IsLedgerOn

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.

IsZoneRedundant

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

Keys

The resource ids of the user assigned identities to use.

Kind

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

LicenseType

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

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
LongTermRetentionBackupResourceId

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

MaintenanceConfigurationId

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

ManagedBy

Resource that manages the database.

ManualCutover

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

The max log size for this database.

MaxSizeBytes

The max size of the database expressed in bytes.

MinCapacity

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

Name

The name of the resource.

(Inherited from ResourceData)
PausedOn

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

PerformCutover

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

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

ReadScale

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.

RecoverableDatabaseId

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

RecoveryServicesRecoveryPointId

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

RequestedBackupStorageRedundancy

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

RequestedServiceObjectiveName

The requested service level objective name of the database.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
RestorableDroppedDatabaseId

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

RestorePointInTime

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

ResumedOn

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

SampleName

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

SecondaryType

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

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 &lt;location&gt; -o table
Get-AzSqlServerServiceObjective -Location &lt;location&gt;
SourceDatabaseDeletedOn

Specifies the time that the database was deleted.

SourceDatabaseId

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

SourceResourceId

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

Status

The status of the database.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
UseFreeLimit

Whether or not the database uses free monthly limits. Allowed on one database in a subscription.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<SqlDatabaseData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SqlDatabaseData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SqlDatabaseData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SqlDatabaseData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SqlDatabaseData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to