你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Database interface

包:

@azure/arm-sql

数据库资源。

扩展

TrackedResource

属性

autoPauseDelay	数据库自动暂停的时间（分钟）。 值为 -1 表示已禁用自动暂停
availabilityZone	指定数据库固定到的可用性区域。
catalogCollation	元数据目录的排序规则。
collation	数据库的排序规则。
createMode	指定数据库创建模式。 默认值：常规数据库创建。 复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。 辅助数据库：将数据库创建为现有数据库的辅助副本 (replica) 。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。 PointInTimeRestore：通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID，并且必须指定 restorePointInTime。 恢复：通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为要还原的可恢复数据库资源 ID。 还原：通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID，则必须指定 sourceDatabaseDeletionDate。 否则，sourceDatabaseId 必须是可还原的已删除数据库资源 ID，并且 sourceDatabaseDeletionDate 将被忽略。 还可以将 restorePointInTime 指定为从较早的时间点还原。 RestoreLongTermRetentionBackup：通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。 DataWarehouse 版本不支持 Copy、Secondary 和 RestoreLongTermRetentionBackup。
creationDate	数据库的创建日期 (ISO8601 格式) 。 注意：此属性不会序列化。 它只能由服务器填充。
currentBackupStorageRedundancy	用于存储此数据库的备份的存储帐户类型。 注意：此属性不会序列化。 它只能由服务器填充。
currentServiceObjectiveName	数据库的当前服务级别目标名称。 注意：此属性不会序列化。 它只能由服务器填充。
currentSku	SKU 的名称和层。 注意：此属性不会序列化。 它只能由服务器填充。
databaseId	数据库的 ID。 注意：此属性不会序列化。 它只能由服务器填充。
defaultSecondaryLocation	此数据库的默认次要区域。 注意：此属性不会序列化。 它只能由服务器填充。
earliestRestoreDate	这会记录此数据库的最早开始日期和时间，该数据库 (ISO8601 格式) 。 注意：此属性不会序列化。 它只能由服务器填充。
elasticPoolId	包含此数据库的弹性池的资源标识符。
encryptionProtector	数据库的 Azure 密钥保管库 URI（如果配置了每个数据库客户管理的密钥）。
failoverGroupId	此数据库所属的故障转移组资源标识符。 注意：此属性不会序列化。 它只能由服务器填充。
federatedClientId	用于跨租户每个数据库 CMK 方案的客户端 ID
highAvailabilityReplicaCount	与用于提供高可用性的数据库关联的次要副本数。 不适用于弹性池中的超大规模数据库。
identity	数据库的 Azure Active Directory 标识。
isInfraEncryptionEnabled	为此数据库启用了基础结构加密。 注意：此属性不会序列化。 它只能由服务器填充。
isLedgerOn	此数据库是否为账本数据库，这意味着数据库中的所有表都是账本表。 注意：创建数据库后，无法更改此属性的值。
keys	要使用的用户分配标识的资源 ID
kind	数据库类型。 这是用于Azure 门户体验的元数据。 注意：此属性不会序列化。 它只能由服务器填充。
licenseType	要为此数据库应用的许可证类型。 LicenseIncluded如果需要许可证，或者BasePrice拥有许可证并且符合Azure 混合权益条件。
longTermRetentionBackupResourceId	与此数据库的创建操作关联的长期保留备份的资源标识符。
maintenanceConfigurationId	分配给数据库的维护配置 ID。 此配置定义将发生维护更新的时间段。
managedBy	管理数据库的资源。 注意：此属性不会序列化。 它只能由服务器填充。
manualCutover	在将数据库更新到超大规模层的操作期间，是否需要执行客户控制的手动直接转换。 此属性仅适用于将数据库从 业务关键/常规用途/高级/标准层缩放到超大规模层时。 指定 manualCutover 时，缩放操作将等待用户输入触发到超大规模数据库的直接转换。 若要触发直接转换，请在缩放操作处于“等待”状态时提供“performCutover”参数。
maxLogSizeBytes	此数据库的最大日志大小。 注意：此属性不会序列化。 它只能由服务器填充。
maxSizeBytes	以字节表示的数据库的最大大小。
minCapacity	数据库始终分配的最小容量（如果未暂停）
pausedDate	用户配置或操作暂停数据库的日期 (ISO8601 格式) 。 如果数据库准备就绪，则为 Null。 注意：此属性不会序列化。 它只能由服务器填充。
performCutover	在缩放操作正在进行时，在等待状态期间触发客户控制的手动直接转换。 此属性参数仅适用于随“manualCutover”参数一起启动的缩放操作。 仅当数据库从业务关键/常规用途/高级/标准层缩放到超大规模层时，此属性才适用。 指定了 performCutover 时，缩放操作将触发直接转换并执行对超大规模数据库的角色更改。
preferredEnclaveType	对数据库请求的 enclave 类型，即默认或 VBS enclave。
readScale	只读路由的状态。 如果启用，其连接字符串中应用程序意向设置为只读的连接可能会路由到同一区域中的只读辅助副本 (replica) 。 不适用于弹性池中的超大规模数据库。
recoverableDatabaseId	与此数据库的创建操作关联的可恢复数据库的资源标识符。
recoveryServicesRecoveryPointId	与此数据库的创建操作关联的恢复点的资源标识符。
requestedBackupStorageRedundancy	用于存储此数据库的备份的存储帐户类型。
requestedServiceObjectiveName	请求的数据库服务级别目标名称。 注意：此属性不会序列化。 它只能由服务器填充。
restorableDroppedDatabaseId	与此数据库的创建操作关联的可还原已删除数据库的资源标识符。
restorePointInTime	指定将还原为创建新数据库的源数据库的时间点 (ISO8601 格式) 。
resumedDate	用户操作或数据库登录恢复数据库的日期 (ISO8601 格式) 。 如果暂停数据库，则为 Null。 注意：此属性不会序列化。 它只能由服务器填充。
sampleName	创建此数据库时要应用的示例架构的名称。
secondaryType	数据库的辅助类型（如果它是辅助数据库）。 有效值为 Geo、Named 和 Standby。
sku	数据库 SKU。 SKU 列表可能因地区和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一： az sql db list-editions -l <location> -o table Get-AzSqlServerServiceObjective -Location <location>
sourceDatabaseDeletionDate	指定删除数据库的时间。
sourceDatabaseId	与此数据库的创建操作关联的源数据库的资源标识符。
sourceResourceId	与此数据库的创建操作关联的源的资源标识符。 此属性仅支持 DataWarehouse 版本，并允许跨订阅还原。 指定 sourceResourceId 时，不得指定 sourceDatabaseId、recoverableDatabaseId、restoreableDroppedDatabaseId 和 sourceDatabaseDeletionDate，并且 CreateMode 必须为 PointInTimeRestore、Restore 或 Recover。 当 createMode 为 PointInTimeRestore 时，sourceResourceId 必须是现有数据库或现有 sql 池的资源 ID，并且必须指定 restorePointInTime。 当 createMode 为 Restore 时，sourceResourceId 必须是可还原的已删除数据库或可还原的已删除 sql 池的资源 ID。 当 createMode 为“恢复”时，sourceResourceId 必须是可恢复数据库或可恢复 sql 池的资源 ID。 当源订阅属于与目标订阅不同的租户时，“x-ms-authorization-auxiliary”标头必须包含源租户的身份验证令牌。 有关“x-ms-authorization-auxiliary”标头的更多详细信息，请参阅 https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
status	数据库的状态。 注意：此属性不会被序列化。 它只能由服务器填充。
zoneRedundant	此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。

继承属性

id	资源 ID。 注意：此属性不会被序列化。 它只能由服务器填充。
location	资源位置。
name	资源名称。 注意：此属性不会被序列化。 它只能由服务器填充。
tags	资源标记。
type	资源类型。 注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

autoPauseDelay

数据库自动暂停的时间（分钟）。 值为 -1 表示已禁用自动暂停

autoPauseDelay?: number

属性值

number

availabilityZone

指定数据库固定到的可用性区域。

availabilityZone?: string

属性值

string

catalogCollation

元数据目录的排序规则。

catalogCollation?: string

属性值

string

collation

数据库的排序规则。

collation?: string

属性值

string

createMode

指定数据库创建模式。

默认值：常规数据库创建。

复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

辅助数据库：将数据库创建为现有数据库的辅助副本 (replica) 。 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

SKU 的名称和层。 注意：此属性不会序列化。 它只能由服务器填充。

currentSku?: Sku

属性值

Sku

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

数据库的 Azure Active Directory 标识。

identity?: DatabaseIdentity

属性值

DatabaseIdentity

isInfraEncryptionEnabled

为此数据库启用了基础结构加密。 注意：此属性不会序列化。 它只能由服务器填充。

isInfraEncryptionEnabled?: boolean

属性值

boolean

isLedgerOn

此数据库是否为账本数据库，这意味着数据库中的所有表都是账本表。 注意：创建数据库后，无法更改此属性的值。

isLedgerOn?: boolean

属性值

boolean

keys

要使用的用户分配标识的资源 ID

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

属性值

{[propertyName: string]: DatabaseKey}

kind

数据库类型。 这是用于Azure 门户体验的元数据。 注意：此属性不会序列化。 它只能由服务器填充。

kind?: string

属性值

string

licenseType

要为此数据库应用的许可证类型。 LicenseIncluded如果需要许可证，或者BasePrice拥有许可证并且符合Azure 混合权益条件。

licenseType?: string

属性值

string

longTermRetentionBackupResourceId

与此数据库的创建操作关联的长期保留备份的资源标识符。

longTermRetentionBackupResourceId?: string

属性值

string

maintenanceConfigurationId

分配给数据库的维护配置 ID。 此配置定义将发生维护更新的时间段。

maintenanceConfigurationId?: string

属性值

string

managedBy

管理数据库的资源。 注意：此属性不会序列化。 它只能由服务器填充。

managedBy?: 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

对数据库请求的 enclave 类型，即默认或 VBS enclave。

preferredEnclaveType?: string

属性值

string

readScale

只读路由的状态。 如果启用，其连接字符串中应用程序意向设置为只读的连接可能会路由到同一区域中的只读辅助副本 (replica) 。 不适用于弹性池中的超大规模数据库。

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

数据库 SKU。

SKU 列表可能因地区和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一：

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

Get-AzSqlServerServiceObjective -Location <location>

sku?: Sku

属性值

Sku

sourceDatabaseDeletionDate

指定删除数据库的时间。

sourceDatabaseDeletionDate?: Date

属性值

Date

sourceDatabaseId

与此数据库的创建操作关联的源数据库的资源标识符。

sourceDatabaseId?: string

属性值

string

sourceResourceId

与此数据库的创建操作关联的源的资源标识符。

此属性仅支持 DataWarehouse 版本，并允许跨订阅还原。

指定 sourceResourceId 时，不得指定 sourceDatabaseId、recoverableDatabaseId、restoreableDroppedDatabaseId 和 sourceDatabaseDeletionDate，并且 CreateMode 必须为 PointInTimeRestore、Restore 或 Recover。

当 createMode 为 PointInTimeRestore 时，sourceResourceId 必须是现有数据库或现有 sql 池的资源 ID，并且必须指定 restorePointInTime。

当 createMode 为 Restore 时，sourceResourceId 必须是可还原的已删除数据库或可还原的已删除 sql 池的资源 ID。

当 createMode 为“恢复”时，sourceResourceId 必须是可恢复数据库或可恢复 sql 池的资源 ID。

当源订阅属于与目标订阅不同的租户时，“x-ms-authorization-auxiliary”标头必须包含源租户的身份验证令牌。 有关“x-ms-authorization-auxiliary”标头的更多详细信息，请参阅 https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

sourceResourceId?: string

属性值

string

status

数据库的状态。 注意：此属性不会被序列化。 它只能由服务器填充。

status?: string

属性值

string

zoneRedundant

此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。

zoneRedundant?: boolean

属性值

boolean

继承属性详细信息

id

资源 ID。 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自TrackedResource.id

location

资源位置。

location: string

属性值

string

继承自TrackedResource.location

name

资源名称。 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自TrackedResource.name

tags

资源标记。

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

属性值

{[propertyName: string]: string}

继承自TrackedResource.tags

type

资源类型。 注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自TrackedResource.type