DatabaseUpdate interface
数据库更新资源。
属性
| auto |
数据库自动暂停的时间(以分钟为单位)。 -1 值表示禁用自动暂停 |
| catalog |
元数据目录的排序规则。 |
| collation | 数据库的排序规则。 |
| create |
指定数据库创建模式。 默认值:常规数据库创建。 复制:将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。 辅助数据库:将数据库创建为现有数据库的次要副本。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。 PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。 恢复:通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为可恢复的数据库资源 ID 才能还原。 还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原删除的数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。 RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。 DataWarehouse 版本不支持 Copy、Secondary 和 RestoreLongTermRetentionBackup。 |
| creation |
数据库的创建日期(ISO8601格式)。 注意:此属性不会序列化。 它只能由服务器填充。 |
| current |
用于存储此数据库的备份的存储帐户类型。 注意:此属性不会序列化。 它只能由服务器填充。 |
| current |
数据库的当前服务级别目标名称。 注意:此属性不会序列化。 它只能由服务器填充。 |
| current |
SKU 的名称和层。 注意:此属性不会序列化。 它只能由服务器填充。 |
| database |
数据库的 ID。 注意:此属性不会序列化。 它只能由服务器填充。 |
| default |
此数据库的默认次要区域。 注意:此属性不会序列化。 它只能由服务器填充。 |
| earliest |
这会记录此数据库的最早开始日期和时间(ISO8601格式)。 注意:此属性不会序列化。 它只能由服务器填充。 |
| elastic |
包含此数据库的弹性池的资源标识符。 |
| encryption |
如果数据库配置了每个数据库客户管理的密钥,则数据库的 Azure 密钥保管库 URI。 |
| failover |
此数据库所属的故障转移组资源标识符。 注意:此属性不会序列化。 它只能由服务器填充。 |
| federated |
用于每个数据库 CMK 方案的跨租户的客户端 ID |
| high |
与用于提供高可用性的数据库关联的次要副本数。 不适用于弹性池中的“超大规模”数据库。 |
| identity | 数据库标识 |
| is |
为此数据库启用了基础结构加密。 注意:此属性不会序列化。 它只能由服务器填充。 |
| is |
此数据库是否为账本数据库,这意味着数据库中的所有表都是账本表。 注意:创建数据库后,无法更改此属性的值。 |
| keys | 要使用的用户分配标识的资源 ID |
| license |
要申请此数据库的许可证类型。 如果需要许可证, |
| long |
与此数据库的创建作关联的长期保留备份的资源标识符。 |
| maintenance |
分配给数据库的维护配置 ID。 此配置定义维护更新的发生时间。 |
| manual |
在“更新数据库”作到“超大规模”层期间,是否需要执行客户控制的手动直接转换。 仅当将数据库从业务关键/常规用途/高级/标准层缩放到“超大规模”层时,此属性才适用。 指定 manualCutover 时,缩放作将等待用户输入触发“超大规模”数据库的直接转换。 若要触发直接转换,请在缩放作处于等待状态时提供“performCutover”参数。 |
| max |
此数据库的最大日志大小。 注意:此属性不会序列化。 它只能由服务器填充。 |
| max |
以字节表示的数据库的最大大小。 |
| min |
数据库始终分配的最小容量(如果未暂停) |
| paused |
由用户配置或作(ISO8601格式)暂停数据库的日期。 如果数据库准备就绪,则为 Null。 注意:此属性不会序列化。 它只能由服务器填充。 |
| perform |
在缩放作正在进行期间触发客户控制的手动直接转换。 此属性参数仅适用于随“manualCutover”参数一起启动的缩放作。 仅当正在将数据库从业务关键/常规用途/高级/标准层缩放到“超大规模”层时,此属性才适用。 指定 performCutover 时,缩放作将触发直接转换并执行超大规模数据库的角色更改。 |
| preferred |
在数据库(即默认或 VBS enclave)上请求的 enclave 类型。 |
| read |
只读路由的状态。 如果启用,将应用程序意向设置为只读的连接在其连接字符串中可能会路由到同一区域中的只读次要副本。 不适用于弹性池中的“超大规模”数据库。 |
| recoverable |
与此数据库的创建作关联的可恢复数据库的资源标识符。 |
| recovery |
与此数据库的创建作关联的恢复点的资源标识符。 |
| requested |
用于存储此数据库的备份的存储帐户类型。 |
| requested |
请求的数据库服务级别目标名称。 注意:此属性不会序列化。 它只能由服务器填充。 |
| restorable |
与此数据库的创建作关联的可还原已删除数据库的资源标识符。 |
| restore |
指定将还原以创建新数据库的源数据库的时间点(ISO8601格式)。 |
| resumed |
用户作或数据库登录恢复数据库的日期(ISO8601格式)。 如果暂停数据库,则为 Null。 注意:此属性不会序列化。 它只能由服务器填充。 |
| sample |
创建此数据库时要应用的示例架构的名称。 |
| secondary |
数据库的辅助类型(如果是辅助数据库)。 有效值为 Geo、Named 和 Standby。 |
| sku | SKU 的名称和层。 |
| source |
指定删除数据库的时间。 |
| source |
与此数据库的创建作关联的源数据库的资源标识符。 |
| status | 数据库的状态。 注意:此属性不会序列化。 它只能由服务器填充。 |
| tags | 资源标记。 |
| zone |
此数据库是否为区域冗余,这意味着此数据库的副本将分布在多个可用性区域。 |
属性详细信息
autoPauseDelay
数据库自动暂停的时间(以分钟为单位)。 -1 值表示禁用自动暂停
autoPauseDelay?: number
属性值
number
catalogCollation
元数据目录的排序规则。
catalogCollation?: string
属性值
string
collation
数据库的排序规则。
collation?: string
属性值
string
createMode
指定数据库创建模式。
默认值:常规数据库创建。
复制:将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。
辅助数据库:将数据库创建为现有数据库的次要副本。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。
PointInTimeRestore:通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID,并且必须指定 restorePointInTime。
恢复:通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为可恢复的数据库资源 ID 才能还原。
还原:通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID,则必须指定 sourceDatabaseDeletionDate。 否则,sourceDatabaseId 必须是可还原删除的数据库资源 ID,并且将忽略 sourceDatabaseDeletionDate。 还可以指定 restorePointInTime,以便从以前的时间点还原。
RestoreLongTermRetentionBackup:通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。
DataWarehouse 版本不支持 Copy、Secondary 和 RestoreLongTermRetentionBackup。
createMode?: string
属性值
string
creationDate
数据库的创建日期(ISO8601格式)。 注意:此属性不会序列化。 它只能由服务器填充。
creationDate?: Date
属性值
Date
currentBackupStorageRedundancy
用于存储此数据库的备份的存储帐户类型。 注意:此属性不会序列化。 它只能由服务器填充。
currentBackupStorageRedundancy?: string
属性值
string
currentServiceObjectiveName
数据库的当前服务级别目标名称。 注意:此属性不会序列化。 它只能由服务器填充。
currentServiceObjectiveName?: string
属性值
string
currentSku
databaseId
数据库的 ID。 注意:此属性不会序列化。 它只能由服务器填充。
databaseId?: string
属性值
string
defaultSecondaryLocation
此数据库的默认次要区域。 注意:此属性不会序列化。 它只能由服务器填充。
defaultSecondaryLocation?: string
属性值
string
earliestRestoreDate
这会记录此数据库的最早开始日期和时间(ISO8601格式)。 注意:此属性不会序列化。 它只能由服务器填充。
earliestRestoreDate?: Date
属性值
Date
elasticPoolId
包含此数据库的弹性池的资源标识符。
elasticPoolId?: string
属性值
string
encryptionProtector
如果数据库配置了每个数据库客户管理的密钥,则数据库的 Azure 密钥保管库 URI。
encryptionProtector?: string
属性值
string
failoverGroupId
此数据库所属的故障转移组资源标识符。 注意:此属性不会序列化。 它只能由服务器填充。
failoverGroupId?: string
属性值
string
federatedClientId
用于每个数据库 CMK 方案的跨租户的客户端 ID
federatedClientId?: string
属性值
string
highAvailabilityReplicaCount
与用于提供高可用性的数据库关联的次要副本数。 不适用于弹性池中的“超大规模”数据库。
highAvailabilityReplicaCount?: number
属性值
number
identity
isInfraEncryptionEnabled
为此数据库启用了基础结构加密。 注意:此属性不会序列化。 它只能由服务器填充。
isInfraEncryptionEnabled?: boolean
属性值
boolean
isLedgerOn
此数据库是否为账本数据库,这意味着数据库中的所有表都是账本表。 注意:创建数据库后,无法更改此属性的值。
isLedgerOn?: boolean
属性值
boolean
keys
要使用的用户分配标识的资源 ID
keys?: {[propertyName: string]: DatabaseKey}
属性值
{[propertyName: string]: DatabaseKey}
licenseType
要申请此数据库的许可证类型。 如果需要许可证,LicenseIncluded,或者 BasePrice 拥有许可证并且有资格获得 Azure 混合权益。
licenseType?: string
属性值
string
longTermRetentionBackupResourceId
与此数据库的创建作关联的长期保留备份的资源标识符。
longTermRetentionBackupResourceId?: string
属性值
string
maintenanceConfigurationId
分配给数据库的维护配置 ID。 此配置定义维护更新的发生时间。
maintenanceConfigurationId?: string
属性值
string
manualCutover
在“更新数据库”作到“超大规模”层期间,是否需要执行客户控制的手动直接转换。
仅当将数据库从业务关键/常规用途/高级/标准层缩放到“超大规模”层时,此属性才适用。
指定 manualCutover 时,缩放作将等待用户输入触发“超大规模”数据库的直接转换。
若要触发直接转换,请在缩放作处于等待状态时提供“performCutover”参数。
manualCutover?: boolean
属性值
boolean
maxLogSizeBytes
此数据库的最大日志大小。 注意:此属性不会序列化。 它只能由服务器填充。
maxLogSizeBytes?: number
属性值
number
maxSizeBytes
以字节表示的数据库的最大大小。
maxSizeBytes?: number
属性值
number
minCapacity
数据库始终分配的最小容量(如果未暂停)
minCapacity?: number
属性值
number
pausedDate
由用户配置或作(ISO8601格式)暂停数据库的日期。 如果数据库准备就绪,则为 Null。 注意:此属性不会序列化。 它只能由服务器填充。
pausedDate?: Date
属性值
Date
performCutover
在缩放作正在进行期间触发客户控制的手动直接转换。
此属性参数仅适用于随“manualCutover”参数一起启动的缩放作。
仅当正在将数据库从业务关键/常规用途/高级/标准层缩放到“超大规模”层时,此属性才适用。
指定 performCutover 时,缩放作将触发直接转换并执行超大规模数据库的角色更改。
performCutover?: boolean
属性值
boolean
preferredEnclaveType
在数据库(即默认或 VBS enclave)上请求的 enclave 类型。
preferredEnclaveType?: string
属性值
string
readScale
只读路由的状态。 如果启用,将应用程序意向设置为只读的连接在其连接字符串中可能会路由到同一区域中的只读次要副本。 不适用于弹性池中的“超大规模”数据库。
readScale?: string
属性值
string
recoverableDatabaseId
与此数据库的创建作关联的可恢复数据库的资源标识符。
recoverableDatabaseId?: string
属性值
string
recoveryServicesRecoveryPointId
与此数据库的创建作关联的恢复点的资源标识符。
recoveryServicesRecoveryPointId?: string
属性值
string
requestedBackupStorageRedundancy
用于存储此数据库的备份的存储帐户类型。
requestedBackupStorageRedundancy?: string
属性值
string
requestedServiceObjectiveName
请求的数据库服务级别目标名称。 注意:此属性不会序列化。 它只能由服务器填充。
requestedServiceObjectiveName?: string
属性值
string
restorableDroppedDatabaseId
与此数据库的创建作关联的可还原已删除数据库的资源标识符。
restorableDroppedDatabaseId?: string
属性值
string
restorePointInTime
指定将还原以创建新数据库的源数据库的时间点(ISO8601格式)。
restorePointInTime?: Date
属性值
Date
resumedDate
用户作或数据库登录恢复数据库的日期(ISO8601格式)。 如果暂停数据库,则为 Null。 注意:此属性不会序列化。 它只能由服务器填充。
resumedDate?: Date
属性值
Date
sampleName
创建此数据库时要应用的示例架构的名称。
sampleName?: string
属性值
string
secondaryType
数据库的辅助类型(如果是辅助数据库)。 有效值为 Geo、Named 和 Standby。
secondaryType?: string
属性值
string
sku
sourceDatabaseDeletionDate
指定删除数据库的时间。
sourceDatabaseDeletionDate?: Date
属性值
Date
sourceDatabaseId
与此数据库的创建作关联的源数据库的资源标识符。
sourceDatabaseId?: string
属性值
string
status
数据库的状态。 注意:此属性不会序列化。 它只能由服务器填充。
status?: string
属性值
string
tags
资源标记。
tags?: {[propertyName: string]: string}
属性值
{[propertyName: string]: string}
zoneRedundant
此数据库是否为区域冗余,这意味着此数据库的副本将分布在多个可用性区域。
zoneRedundant?: boolean
属性值
boolean