ArmSqlModelFactory.SqlDatabasePatch Method

Definition

Overloads

SqlDatabasePatch(SqlSku, DatabaseIdentity, IDictionary<String, String>, Nullable<SqlDatabaseCreateMode>, String, Nullable<Int64>, Nullable<SampleSchemaName>, ResourceIdentifier, ResourceIdentifier, Nullable<SqlDatabaseStatus>, Nullable<Guid>, Nullable<DateTimeOffset>, String, String, Nullable<AzureLocation>, ResourceIdentifier, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, Nullable<CatalogCollationType>, Nullable<Boolean>, Nullable<DatabaseLicenseType>, Nullable<Int64>, Nullable<DateTimeOffset>, Nullable<DatabaseReadScale>, Nullable<Int32>, Nullable<SecondaryType>, SqlSku, Nullable<Int32>, Nullable<SqlBackupStorageRedundancy>, Nullable<SqlBackupStorageRedundancy>, Nullable<Double>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, Nullable<SqlAlwaysEncryptedEnclaveType>)
SqlDatabasePatch(SqlSku, DatabaseIdentity, IDictionary<String, String>, Nullable<SqlDatabaseCreateMode>, String, Nullable<Int64>, Nullable<SampleSchemaName>, ResourceIdentifier, ResourceIdentifier, Nullable<SqlDatabaseStatus>, Nullable<Guid>, Nullable<DateTimeOffset>, String, String, Nullable<AzureLocation>, ResourceIdentifier, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, Nullable<CatalogCollationType>, Nullable<Boolean>, Nullable<DatabaseLicenseType>, Nullable<Int64>, Nullable<DateTimeOffset>, Nullable<DatabaseReadScale>, Nullable<Int32>, Nullable<SecondaryType>, SqlSku, Nullable<Int32>, Nullable<SqlBackupStorageRedundancy>, Nullable<SqlBackupStorageRedundancy>, Nullable<Double>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, IDictionary<String,SqlDatabaseKey>, String, Nullable<SqlAlwaysEncryptedEnclaveType>, Nullable<Boolean>, Nullable<FreeLimitExhaustionBehavior>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Initializes a new instance of SqlDatabasePatch.

SqlDatabasePatch(SqlSku, DatabaseIdentity, IDictionary<String, String>, Nullable<SqlDatabaseCreateMode>, String, Nullable<Int64>, Nullable<SampleSchemaName>, ResourceIdentifier, ResourceIdentifier, Nullable<SqlDatabaseStatus>, Nullable<Guid>, Nullable<DateTimeOffset>, String, String, Nullable<AzureLocation>, ResourceIdentifier, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, Nullable<CatalogCollationType>, Nullable<Boolean>, Nullable<DatabaseLicenseType>, Nullable<Int64>, Nullable<DateTimeOffset>, Nullable<DatabaseReadScale>, Nullable<Int32>, Nullable<SecondaryType>, SqlSku, Nullable<Int32>, Nullable<SqlBackupStorageRedundancy>, Nullable<SqlBackupStorageRedundancy>, Nullable<Double>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, Nullable<SqlAlwaysEncryptedEnclaveType>)

Source:
ArmSqlModelFactory.cs
public static Azure.ResourceManager.Sql.Models.SqlDatabasePatch SqlDatabasePatch (Azure.ResourceManager.Sql.Models.SqlSku sku = default, Azure.ResourceManager.Sql.Models.DatabaseIdentity identity = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.ResourceManager.Sql.Models.SqlDatabaseCreateMode? createMode = default, string collation = default, long? maxSizeBytes = default, Azure.ResourceManager.Sql.Models.SampleSchemaName? sampleName = default, Azure.Core.ResourceIdentifier elasticPoolId = default, Azure.Core.ResourceIdentifier sourceDatabaseId = default, Azure.ResourceManager.Sql.Models.SqlDatabaseStatus? status = default, Guid? databaseId = default, DateTimeOffset? createdOn = default, string currentServiceObjectiveName = default, string requestedServiceObjectiveName = default, Azure.Core.AzureLocation? defaultSecondaryLocation = default, Azure.Core.ResourceIdentifier failoverGroupId = default, DateTimeOffset? restorePointInTime = default, DateTimeOffset? sourceDatabaseDeletedOn = default, Azure.Core.ResourceIdentifier recoveryServicesRecoveryPointId = default, Azure.Core.ResourceIdentifier longTermRetentionBackupResourceId = default, Azure.Core.ResourceIdentifier recoverableDatabaseId = default, Azure.Core.ResourceIdentifier restorableDroppedDatabaseId = default, Azure.ResourceManager.Sql.Models.CatalogCollationType? catalogCollation = default, bool? isZoneRedundant = default, Azure.ResourceManager.Sql.Models.DatabaseLicenseType? licenseType = default, long? maxLogSizeBytes = default, DateTimeOffset? earliestRestoreOn = default, Azure.ResourceManager.Sql.Models.DatabaseReadScale? readScale = default, int? highAvailabilityReplicaCount = default, Azure.ResourceManager.Sql.Models.SecondaryType? secondaryType = default, Azure.ResourceManager.Sql.Models.SqlSku currentSku = default, int? autoPauseDelay = default, Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy? currentBackupStorageRedundancy = default, Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy? requestedBackupStorageRedundancy = default, double? minCapacity = default, DateTimeOffset? pausedOn = default, DateTimeOffset? resumedOn = default, Azure.Core.ResourceIdentifier maintenanceConfigurationId = default, bool? isLedgerOn = default, bool? isInfraEncryptionEnabled = default, Guid? federatedClientId = default, Azure.ResourceManager.Sql.Models.SqlAlwaysEncryptedEnclaveType? preferredEnclaveType = default);
static member SqlDatabasePatch : Azure.ResourceManager.Sql.Models.SqlSku * Azure.ResourceManager.Sql.Models.DatabaseIdentity * System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseCreateMode> * string * Nullable<int64> * Nullable<Azure.ResourceManager.Sql.Models.SampleSchemaName> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseStatus> * Nullable<Guid> * Nullable<DateTimeOffset> * string * string * Nullable<Azure.Core.AzureLocation> * Azure.Core.ResourceIdentifier * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.Sql.Models.CatalogCollationType> * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.DatabaseLicenseType> * Nullable<int64> * Nullable<DateTimeOffset> * Nullable<Azure.ResourceManager.Sql.Models.DatabaseReadScale> * Nullable<int> * Nullable<Azure.ResourceManager.Sql.Models.SecondaryType> * Azure.ResourceManager.Sql.Models.SqlSku * Nullable<int> * Nullable<Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy> * Nullable<Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy> * Nullable<double> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.Core.ResourceIdentifier * Nullable<bool> * Nullable<bool> * Nullable<Guid> * Nullable<Azure.ResourceManager.Sql.Models.SqlAlwaysEncryptedEnclaveType> -> Azure.ResourceManager.Sql.Models.SqlDatabasePatch
Public Shared Function SqlDatabasePatch (Optional sku As SqlSku = Nothing, Optional identity As DatabaseIdentity = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional createMode As Nullable(Of SqlDatabaseCreateMode) = Nothing, Optional collation As String = Nothing, Optional maxSizeBytes As Nullable(Of Long) = Nothing, Optional sampleName As Nullable(Of SampleSchemaName) = Nothing, Optional elasticPoolId As ResourceIdentifier = Nothing, Optional sourceDatabaseId As ResourceIdentifier = Nothing, Optional status As Nullable(Of SqlDatabaseStatus) = Nothing, Optional databaseId As Nullable(Of Guid) = Nothing, Optional createdOn As Nullable(Of DateTimeOffset) = Nothing, Optional currentServiceObjectiveName As String = Nothing, Optional requestedServiceObjectiveName As String = Nothing, Optional defaultSecondaryLocation As Nullable(Of AzureLocation) = Nothing, Optional failoverGroupId As ResourceIdentifier = Nothing, Optional restorePointInTime As Nullable(Of DateTimeOffset) = Nothing, Optional sourceDatabaseDeletedOn As Nullable(Of DateTimeOffset) = Nothing, Optional recoveryServicesRecoveryPointId As ResourceIdentifier = Nothing, Optional longTermRetentionBackupResourceId As ResourceIdentifier = Nothing, Optional recoverableDatabaseId As ResourceIdentifier = Nothing, Optional restorableDroppedDatabaseId As ResourceIdentifier = Nothing, Optional catalogCollation As Nullable(Of CatalogCollationType) = Nothing, Optional isZoneRedundant As Nullable(Of Boolean) = Nothing, Optional licenseType As Nullable(Of DatabaseLicenseType) = Nothing, Optional maxLogSizeBytes As Nullable(Of Long) = Nothing, Optional earliestRestoreOn As Nullable(Of DateTimeOffset) = Nothing, Optional readScale As Nullable(Of DatabaseReadScale) = Nothing, Optional highAvailabilityReplicaCount As Nullable(Of Integer) = Nothing, Optional secondaryType As Nullable(Of SecondaryType) = Nothing, Optional currentSku As SqlSku = Nothing, Optional autoPauseDelay As Nullable(Of Integer) = Nothing, Optional currentBackupStorageRedundancy As Nullable(Of SqlBackupStorageRedundancy) = Nothing, Optional requestedBackupStorageRedundancy As Nullable(Of SqlBackupStorageRedundancy) = Nothing, Optional minCapacity As Nullable(Of Double) = Nothing, Optional pausedOn As Nullable(Of DateTimeOffset) = Nothing, Optional resumedOn As Nullable(Of DateTimeOffset) = Nothing, Optional maintenanceConfigurationId As ResourceIdentifier = Nothing, Optional isLedgerOn As Nullable(Of Boolean) = Nothing, Optional isInfraEncryptionEnabled As Nullable(Of Boolean) = Nothing, Optional federatedClientId As Nullable(Of Guid) = Nothing, Optional preferredEnclaveType As Nullable(Of SqlAlwaysEncryptedEnclaveType) = Nothing) As SqlDatabasePatch

Parameters

sku
SqlSku
identity
DatabaseIdentity
collation
String
maxSizeBytes
Nullable<Int64>
elasticPoolId
ResourceIdentifier
sourceDatabaseId
ResourceIdentifier
databaseId
Nullable<Guid>
currentServiceObjectiveName
String
requestedServiceObjectiveName
String
defaultSecondaryLocation
Nullable<AzureLocation>
failoverGroupId
ResourceIdentifier
restorePointInTime
Nullable<DateTimeOffset>
sourceDatabaseDeletedOn
Nullable<DateTimeOffset>
recoveryServicesRecoveryPointId
ResourceIdentifier
longTermRetentionBackupResourceId
ResourceIdentifier
recoverableDatabaseId
ResourceIdentifier
restorableDroppedDatabaseId
ResourceIdentifier
catalogCollation
Nullable<CatalogCollationType>
isZoneRedundant
Nullable<Boolean>
maxLogSizeBytes
Nullable<Int64>
earliestRestoreOn
Nullable<DateTimeOffset>
highAvailabilityReplicaCount
Nullable<Int32>
secondaryType
Nullable<SecondaryType>
currentSku
SqlSku
autoPauseDelay
Nullable<Int32>
currentBackupStorageRedundancy
Nullable<SqlBackupStorageRedundancy>
requestedBackupStorageRedundancy
Nullable<SqlBackupStorageRedundancy>
minCapacity
Nullable<Double>
maintenanceConfigurationId
ResourceIdentifier
isLedgerOn
Nullable<Boolean>
isInfraEncryptionEnabled
Nullable<Boolean>
federatedClientId
Nullable<Guid>
preferredEnclaveType
Nullable<SqlAlwaysEncryptedEnclaveType>

Returns

Applies to

SqlDatabasePatch(SqlSku, DatabaseIdentity, IDictionary<String, String>, Nullable<SqlDatabaseCreateMode>, String, Nullable<Int64>, Nullable<SampleSchemaName>, ResourceIdentifier, ResourceIdentifier, Nullable<SqlDatabaseStatus>, Nullable<Guid>, Nullable<DateTimeOffset>, String, String, Nullable<AzureLocation>, ResourceIdentifier, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, ResourceIdentifier, Nullable<CatalogCollationType>, Nullable<Boolean>, Nullable<DatabaseLicenseType>, Nullable<Int64>, Nullable<DateTimeOffset>, Nullable<DatabaseReadScale>, Nullable<Int32>, Nullable<SecondaryType>, SqlSku, Nullable<Int32>, Nullable<SqlBackupStorageRedundancy>, Nullable<SqlBackupStorageRedundancy>, Nullable<Double>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, ResourceIdentifier, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, IDictionary<String,SqlDatabaseKey>, String, Nullable<SqlAlwaysEncryptedEnclaveType>, Nullable<Boolean>, Nullable<FreeLimitExhaustionBehavior>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

Source:
ArmSqlModelFactory.cs

Initializes a new instance of SqlDatabasePatch.

public static Azure.ResourceManager.Sql.Models.SqlDatabasePatch SqlDatabasePatch (Azure.ResourceManager.Sql.Models.SqlSku sku = default, Azure.ResourceManager.Sql.Models.DatabaseIdentity identity = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.ResourceManager.Sql.Models.SqlDatabaseCreateMode? createMode = default, string collation = default, long? maxSizeBytes = default, Azure.ResourceManager.Sql.Models.SampleSchemaName? sampleName = default, Azure.Core.ResourceIdentifier elasticPoolId = default, Azure.Core.ResourceIdentifier sourceDatabaseId = default, Azure.ResourceManager.Sql.Models.SqlDatabaseStatus? status = default, Guid? databaseId = default, DateTimeOffset? createdOn = default, string currentServiceObjectiveName = default, string requestedServiceObjectiveName = default, Azure.Core.AzureLocation? defaultSecondaryLocation = default, Azure.Core.ResourceIdentifier failoverGroupId = default, DateTimeOffset? restorePointInTime = default, DateTimeOffset? sourceDatabaseDeletedOn = default, Azure.Core.ResourceIdentifier recoveryServicesRecoveryPointId = default, Azure.Core.ResourceIdentifier longTermRetentionBackupResourceId = default, Azure.Core.ResourceIdentifier recoverableDatabaseId = default, Azure.Core.ResourceIdentifier restorableDroppedDatabaseId = default, Azure.ResourceManager.Sql.Models.CatalogCollationType? catalogCollation = default, bool? isZoneRedundant = default, Azure.ResourceManager.Sql.Models.DatabaseLicenseType? licenseType = default, long? maxLogSizeBytes = default, DateTimeOffset? earliestRestoreOn = default, Azure.ResourceManager.Sql.Models.DatabaseReadScale? readScale = default, int? highAvailabilityReplicaCount = default, Azure.ResourceManager.Sql.Models.SecondaryType? secondaryType = default, Azure.ResourceManager.Sql.Models.SqlSku currentSku = default, int? autoPauseDelay = default, Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy? currentBackupStorageRedundancy = default, Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy? requestedBackupStorageRedundancy = default, double? minCapacity = default, DateTimeOffset? pausedOn = default, DateTimeOffset? resumedOn = default, Azure.Core.ResourceIdentifier maintenanceConfigurationId = default, bool? isLedgerOn = default, bool? isInfraEncryptionEnabled = default, Guid? federatedClientId = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.Sql.Models.SqlDatabaseKey> keys = default, string encryptionProtector = default, Azure.ResourceManager.Sql.Models.SqlAlwaysEncryptedEnclaveType? preferredEnclaveType = default, bool? useFreeLimit = default, Azure.ResourceManager.Sql.Models.FreeLimitExhaustionBehavior? freeLimitExhaustionBehavior = default, bool? manualCutover = default, bool? performCutover = default, bool? encryptionProtectorAutoRotation = default);
static member SqlDatabasePatch : Azure.ResourceManager.Sql.Models.SqlSku * Azure.ResourceManager.Sql.Models.DatabaseIdentity * System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseCreateMode> * string * Nullable<int64> * Nullable<Azure.ResourceManager.Sql.Models.SampleSchemaName> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.Sql.Models.SqlDatabaseStatus> * Nullable<Guid> * Nullable<DateTimeOffset> * string * string * Nullable<Azure.Core.AzureLocation> * Azure.Core.ResourceIdentifier * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.Sql.Models.CatalogCollationType> * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.DatabaseLicenseType> * Nullable<int64> * Nullable<DateTimeOffset> * Nullable<Azure.ResourceManager.Sql.Models.DatabaseReadScale> * Nullable<int> * Nullable<Azure.ResourceManager.Sql.Models.SecondaryType> * Azure.ResourceManager.Sql.Models.SqlSku * Nullable<int> * Nullable<Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy> * Nullable<Azure.ResourceManager.Sql.Models.SqlBackupStorageRedundancy> * Nullable<double> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.Core.ResourceIdentifier * Nullable<bool> * Nullable<bool> * Nullable<Guid> * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.Sql.Models.SqlDatabaseKey> * string * Nullable<Azure.ResourceManager.Sql.Models.SqlAlwaysEncryptedEnclaveType> * Nullable<bool> * Nullable<Azure.ResourceManager.Sql.Models.FreeLimitExhaustionBehavior> * Nullable<bool> * Nullable<bool> * Nullable<bool> -> Azure.ResourceManager.Sql.Models.SqlDatabasePatch
Public Shared Function SqlDatabasePatch (Optional sku As SqlSku = Nothing, Optional identity As DatabaseIdentity = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional createMode As Nullable(Of SqlDatabaseCreateMode) = Nothing, Optional collation As String = Nothing, Optional maxSizeBytes As Nullable(Of Long) = Nothing, Optional sampleName As Nullable(Of SampleSchemaName) = Nothing, Optional elasticPoolId As ResourceIdentifier = Nothing, Optional sourceDatabaseId As ResourceIdentifier = Nothing, Optional status As Nullable(Of SqlDatabaseStatus) = Nothing, Optional databaseId As Nullable(Of Guid) = Nothing, Optional createdOn As Nullable(Of DateTimeOffset) = Nothing, Optional currentServiceObjectiveName As String = Nothing, Optional requestedServiceObjectiveName As String = Nothing, Optional defaultSecondaryLocation As Nullable(Of AzureLocation) = Nothing, Optional failoverGroupId As ResourceIdentifier = Nothing, Optional restorePointInTime As Nullable(Of DateTimeOffset) = Nothing, Optional sourceDatabaseDeletedOn As Nullable(Of DateTimeOffset) = Nothing, Optional recoveryServicesRecoveryPointId As ResourceIdentifier = Nothing, Optional longTermRetentionBackupResourceId As ResourceIdentifier = Nothing, Optional recoverableDatabaseId As ResourceIdentifier = Nothing, Optional restorableDroppedDatabaseId As ResourceIdentifier = Nothing, Optional catalogCollation As Nullable(Of CatalogCollationType) = Nothing, Optional isZoneRedundant As Nullable(Of Boolean) = Nothing, Optional licenseType As Nullable(Of DatabaseLicenseType) = Nothing, Optional maxLogSizeBytes As Nullable(Of Long) = Nothing, Optional earliestRestoreOn As Nullable(Of DateTimeOffset) = Nothing, Optional readScale As Nullable(Of DatabaseReadScale) = Nothing, Optional highAvailabilityReplicaCount As Nullable(Of Integer) = Nothing, Optional secondaryType As Nullable(Of SecondaryType) = Nothing, Optional currentSku As SqlSku = Nothing, Optional autoPauseDelay As Nullable(Of Integer) = Nothing, Optional currentBackupStorageRedundancy As Nullable(Of SqlBackupStorageRedundancy) = Nothing, Optional requestedBackupStorageRedundancy As Nullable(Of SqlBackupStorageRedundancy) = Nothing, Optional minCapacity As Nullable(Of Double) = Nothing, Optional pausedOn As Nullable(Of DateTimeOffset) = Nothing, Optional resumedOn As Nullable(Of DateTimeOffset) = Nothing, Optional maintenanceConfigurationId As ResourceIdentifier = Nothing, Optional isLedgerOn As Nullable(Of Boolean) = Nothing, Optional isInfraEncryptionEnabled As Nullable(Of Boolean) = Nothing, Optional federatedClientId As Nullable(Of Guid) = Nothing, Optional keys As IDictionary(Of String, SqlDatabaseKey) = Nothing, Optional encryptionProtector As String = Nothing, Optional preferredEnclaveType As Nullable(Of SqlAlwaysEncryptedEnclaveType) = Nothing, Optional useFreeLimit As Nullable(Of Boolean) = Nothing, Optional freeLimitExhaustionBehavior As Nullable(Of FreeLimitExhaustionBehavior) = Nothing, Optional manualCutover As Nullable(Of Boolean) = Nothing, Optional performCutover As Nullable(Of Boolean) = Nothing, Optional encryptionProtectorAutoRotation As Nullable(Of Boolean) = Nothing) As SqlDatabasePatch

Parameters

sku
SqlSku

The name and tier of the SKU.

identity
DatabaseIdentity

Database identity.

tags
IDictionary<String,String>

Resource tags.

createMode
Nullable<SqlDatabaseCreateMode>

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.

collation
String

The collation of the database.

maxSizeBytes
Nullable<Int64>

The max size of the database expressed in bytes.

sampleName
Nullable<SampleSchemaName>

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

elasticPoolId
ResourceIdentifier

The resource identifier of the elastic pool containing this database.

sourceDatabaseId
ResourceIdentifier

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

status
Nullable<SqlDatabaseStatus>

The status of the database.

databaseId
Nullable<Guid>

The ID of the database.

createdOn
Nullable<DateTimeOffset>

The creation date of the database (ISO8601 format).

currentServiceObjectiveName
String

The current service level objective name of the database.

requestedServiceObjectiveName
String

The requested service level objective name of the database.

defaultSecondaryLocation
Nullable<AzureLocation>

The default secondary region for this database.

failoverGroupId
ResourceIdentifier

Failover Group resource identifier that this database belongs to.

restorePointInTime
Nullable<DateTimeOffset>

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

sourceDatabaseDeletedOn
Nullable<DateTimeOffset>

Specifies the time that the database was deleted.

recoveryServicesRecoveryPointId
ResourceIdentifier

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

longTermRetentionBackupResourceId
ResourceIdentifier

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

recoverableDatabaseId
ResourceIdentifier

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

restorableDroppedDatabaseId
ResourceIdentifier

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

catalogCollation
Nullable<CatalogCollationType>

Collation of the metadata catalog.

isZoneRedundant
Nullable<Boolean>

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

licenseType
Nullable<DatabaseLicenseType>

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.

maxLogSizeBytes
Nullable<Int64>

The max log size for this database.

earliestRestoreOn
Nullable<DateTimeOffset>

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

readScale
Nullable<DatabaseReadScale>

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.

highAvailabilityReplicaCount
Nullable<Int32>

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.

secondaryType
Nullable<SecondaryType>

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

currentSku
SqlSku

The name and tier of the SKU.

autoPauseDelay
Nullable<Int32>

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

currentBackupStorageRedundancy
Nullable<SqlBackupStorageRedundancy>

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

requestedBackupStorageRedundancy
Nullable<SqlBackupStorageRedundancy>

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

minCapacity
Nullable<Double>

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

pausedOn
Nullable<DateTimeOffset>

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

resumedOn
Nullable<DateTimeOffset>

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

maintenanceConfigurationId
ResourceIdentifier

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

isLedgerOn
Nullable<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.

isInfraEncryptionEnabled
Nullable<Boolean>

Infra encryption is enabled for this database.

federatedClientId
Nullable<Guid>

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

keys
IDictionary<String,SqlDatabaseKey>

The resource ids of the user assigned identities to use.

encryptionProtector
String

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

preferredEnclaveType
Nullable<SqlAlwaysEncryptedEnclaveType>

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

useFreeLimit
Nullable<Boolean>

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

freeLimitExhaustionBehavior
Nullable<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.

manualCutover
Nullable<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.

performCutover
Nullable<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.

encryptionProtectorAutoRotation
Nullable<Boolean>

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

Returns

A new SqlDatabasePatch instance for mocking.

Applies to