Dela via


SqlDatabasePatch Class

Definition

A database update resource.

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

Constructors

SqlDatabasePatch()

Initializes a new instance of SqlDatabasePatch.

Properties

AutoPauseDelay

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

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.

Identity

Database identity.

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.

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.

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.

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.

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.

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 name and tier of the SKU.

SourceDatabaseDeletedOn

Specifies the time that the database was deleted.

SourceDatabaseId

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

Status

The status of the database.

Tags

Resource tags.

UseFreeLimit

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

Explicit Interface Implementations

IJsonModel<SqlDatabasePatch>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<SqlDatabasePatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SqlDatabasePatch>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SqlDatabasePatch>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<SqlDatabasePatch>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to