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

ManagedInstance interface

包:

@azure/arm-sql

Azure SQL托管实例。

扩展

TrackedResource

属性

administratorLogin	托管实例的管理员用户名。 仅当 (创建托管实例并且需要创建) 时，才能指定。
administratorLoginPassword	创建托管实例 () 所需的管理员登录密码。
administrators	实例的 Azure Active Directory 管理员。 这只能在创建实例时使用。 如果使用实例更新，则会忽略它，否则将导致错误。 对于更新，需要使用单个 API。
collation	托管实例的排序规则。
currentBackupStorageRedundancy	用于存储此实例备份的存储帐户类型。 选项为 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage) 注意：此属性不会被序列化。 它只能由服务器填充。
dnsZone	托管实例位于的 Dns 区域。 注意：此属性不会被序列化。 它只能由服务器填充。
dnsZonePartner	另一个托管实例的资源 ID，该托管实例在创建后将共享其 DNS 区域。
fullyQualifiedDomainName	托管实例的完全限定域名。 注意：此属性不会被序列化。 它只能由服务器填充。
identity	托管实例的 Azure Active Directory 标识。
instancePoolId	此托管服务器所属的实例池的 ID。
keyId	用于加密的密钥的 CMK URI。
licenseType	许可证类型。 可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格，“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。
maintenanceConfigurationId	指定要应用于此托管实例的维护配置 ID。
managedInstanceCreateMode	指定数据库创建模式。 默认值：定期创建实例。 还原：通过将一组备份还原到特定时间点来创建实例。 必须指定 RestorePointInTime 和 SourceManagedInstanceId。
minimalTlsVersion	最低 TLS 版本。 允许的值：“None”、“1.0”、“1.1”、“1.2”
primaryUserAssignedIdentityId	默认要使用的用户分配标识的资源 ID。
privateEndpointConnections	托管实例上的专用终结点连接列表。 注意：此属性不会序列化。 它只能由服务器填充。
provisioningState	注意：此属性不会序列化。 它只能由服务器填充。
proxyOverride	用于连接到实例的连接类型。
publicDataEndpointEnabled	是否启用公共数据终结点。
requestedBackupStorageRedundancy	用于存储此实例的备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)
restorePointInTime	指定将还原为创建新数据库的源数据库的时间点 (ISO8601 格式) 。
servicePrincipal	托管实例的服务主体。
sku	托管实例 SKU。 sku.name 允许的值：GP_Gen5、GP_G8IM、GP_G8IH、BC_Gen5、BC_G8IM、BC_G8IH
sourceManagedInstanceId	与此实例的创建操作关联的源托管实例的资源标识符。
state	托管实例的状态。 注意：此属性不会序列化。 它只能由服务器填充。
storageSizeInGB	存储大小（以 GB 为单位）。 最小值：32。 最大值：16384。 仅允许 32 GB 的增量。 最大值取决于所选的硬件系列和 vCore 数。
subnetId	托管实例的子网资源 ID。
timezoneId	时区的 ID。 允许的值是 Windows 支持的时区。 Windows 在 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 下的注册表中保留有关受支持时区（包括 ID）的详细信息。 可以通过SQL Server查询 SELECT name AS timezone_id FROM sys.time_zone_info 来获取这些注册表值。 还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]：：GetSystemTimeZones () 来获取 ID 列表。 有效时区 ID 的示例是“太平洋标准时间”或“W”。 欧洲标准时间”。
vCores	vCore 数。 允许的值：8、16、24、32、40、64、80。
zoneRedundant	是否启用了 multi-az。

继承属性

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

属性详细信息

administratorLogin

托管实例的管理员用户名。 仅当 (创建托管实例并且需要创建) 时，才能指定。

administratorLogin?: string

属性值

string

administratorLoginPassword

创建托管实例 () 所需的管理员登录密码。

administratorLoginPassword?: string

属性值

string

administrators

实例的 Azure Active Directory 管理员。 这只能在创建实例时使用。 如果使用实例更新，则会忽略它，否则将导致错误。 对于更新，需要使用单个 API。

administrators?: ManagedInstanceExternalAdministrator

属性值

ManagedInstanceExternalAdministrator

collation

托管实例的排序规则。

collation?: string

属性值

string

currentBackupStorageRedundancy

用于存储此实例备份的存储帐户类型。 选项为 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage) 注意：此属性不会被序列化。 它只能由服务器填充。

currentBackupStorageRedundancy?: string

属性值

string

dnsZone

托管实例位于的 Dns 区域。 注意：此属性不会被序列化。 它只能由服务器填充。

dnsZone?: string

属性值

string

dnsZonePartner

另一个托管实例的资源 ID，该托管实例在创建后将共享其 DNS 区域。

dnsZonePartner?: string

属性值

string

fullyQualifiedDomainName

托管实例的完全限定域名。 注意：此属性不会被序列化。 它只能由服务器填充。

fullyQualifiedDomainName?: string

属性值

string

identity

托管实例的 Azure Active Directory 标识。

identity?: ResourceIdentity

属性值

ResourceIdentity

instancePoolId

此托管服务器所属的实例池的 ID。

instancePoolId?: string

属性值

string

keyId

用于加密的密钥的 CMK URI。

keyId?: string

属性值

string

licenseType

许可证类型。 可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格，“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。

licenseType?: string

属性值

string

maintenanceConfigurationId

指定要应用于此托管实例的维护配置 ID。

maintenanceConfigurationId?: string

属性值

string

managedInstanceCreateMode

指定数据库创建模式。

默认值：定期创建实例。

还原：通过将一组备份还原到特定时间点来创建实例。 必须指定 RestorePointInTime 和 SourceManagedInstanceId。

managedInstanceCreateMode?: string

属性值

string

minimalTlsVersion

最低 TLS 版本。 允许的值：“None”、“1.0”、“1.1”、“1.2”

minimalTlsVersion?: string

属性值

string

primaryUserAssignedIdentityId

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

primaryUserAssignedIdentityId?: string

属性值

string

privateEndpointConnections

托管实例上的专用终结点连接列表。 注意：此属性不会序列化。 它只能由服务器填充。

privateEndpointConnections?: ManagedInstancePecProperty[]

属性值

ManagedInstancePecProperty[]

provisioningState

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

provisioningState?: string

属性值

string

proxyOverride

用于连接到实例的连接类型。

proxyOverride?: string

属性值

string

publicDataEndpointEnabled

是否启用公共数据终结点。

publicDataEndpointEnabled?: boolean

属性值

boolean

requestedBackupStorageRedundancy

用于存储此实例的备份的存储帐户类型。 选项包括 Local (LocalRedundantStorage) 、Zone (ZoneRedundantStorage) 、Geo (GeoRedundantStorage) 和 GeoZone (GeoZoneRedundantStorage)

requestedBackupStorageRedundancy?: string

属性值

string

restorePointInTime

指定将还原为创建新数据库的源数据库的时间点 (ISO8601 格式) 。

restorePointInTime?: Date

属性值

Date

servicePrincipal

托管实例的服务主体。

servicePrincipal?: ServicePrincipal

属性值

ServicePrincipal

sku

托管实例 SKU。 sku.name 允许的值：GP_Gen5、GP_G8IM、GP_G8IH、BC_Gen5、BC_G8IM、BC_G8IH

sku?: Sku

属性值

Sku

sourceManagedInstanceId

与此实例的创建操作关联的源托管实例的资源标识符。

sourceManagedInstanceId?: string

属性值

string

state

托管实例的状态。 注意：此属性不会序列化。 它只能由服务器填充。

state?: string

属性值

string

storageSizeInGB

存储大小（以 GB 为单位）。 最小值：32。 最大值：16384。 仅允许 32 GB 的增量。 最大值取决于所选的硬件系列和 vCore 数。

storageSizeInGB?: number

属性值

number

subnetId

托管实例的子网资源 ID。

subnetId?: string

属性值

string

timezoneId

时区的 ID。 允许的值是 Windows 支持的时区。 Windows 在 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 下的注册表中保留有关受支持时区（包括 ID）的详细信息。 可以通过SQL Server查询 SELECT name AS timezone_id FROM sys.time_zone_info 来获取这些注册表值。 还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]：：GetSystemTimeZones () 来获取 ID 列表。 有效时区 ID 的示例是“太平洋标准时间”或“W”。 欧洲标准时间”。

timezoneId?: string

属性值

string

vCores

vCore 数。 允许的值：8、16、24、32、40、64、80。

vCores?: number

属性值

number

zoneRedundant

是否启用了 multi-az。

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