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

Microsoft.Sql managedInstances 2021-02-01-preview

项目
02/28/2024

Bicep 资源定义

可以使用面向以下操作部署 managedInstances 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Sql/managedInstances 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Sql/managedInstances@2021-02-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    administrators: {
      administratorType: 'ActiveDirectory'
      azureADOnlyAuthentication: bool
      login: 'string'
      principalType: 'string'
      sid: 'string'
      tenantId: 'string'
    }
    collation: 'string'
    dnsZonePartner: 'string'
    instancePoolId: 'string'
    keyId: 'string'
    licenseType: 'string'
    maintenanceConfigurationId: 'string'
    managedInstanceCreateMode: 'string'
    minimalTlsVersion: 'string'
    primaryUserAssignedIdentityId: 'string'
    proxyOverride: 'string'
    publicDataEndpointEnabled: bool
    restorePointInTime: 'string'
    sourceManagedInstanceId: 'string'
    storageAccountType: 'string'
    storageSizeInGB: int
    subnetId: 'string'
    timezoneId: 'string'
    vCores: int
    zoneRedundant: bool
  }
}

属性值

managedInstances

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：小写字母、数字和连字符。不能以连字符开头或结尾。资源名称在 Azure 中必须是唯一的。
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
sku	托管实例 SKU。 sku.name 允许的值：GP_Gen4、GP_Gen5、BC_Gen4、BC_Gen5	Sku
标识	托管实例的 Azure Active Directory 标识。	ResourceIdentity
properties	资源属性。	ManagedInstanceProperties

ResourceIdentity

名称	说明	Value
type	标识类型。将其设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	要使用的用户分配标识的资源 ID	ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		UserIdentity

UserIdentity

此对象不包含部署期间要设置的任何属性。所有属性均为 ReadOnly。

ManagedInstanceProperties

名称	说明	值
administratorLogin	托管实例的管理员用户名。仅当 (创建托管实例并且需要创建) 时指定。	字符串
administratorLoginPassword	创建托管实例) (管理员登录密码。	字符串
管理员	服务器的 Azure Active Directory 管理员。	ManagedInstanceExternalAdministrator
collation	托管实例的排序规则。	字符串
dnsZonePartner	另一个托管实例的资源 ID，该托管实例在创建后将共享其 DNS 区域。	字符串
instancePoolId	此托管服务器所属的实例池的 ID。	字符串
keyId	要用于加密的密钥的 CMK URI。	字符串
LicenseType	许可证类型。可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格，“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。	“BasePrice” “LicenseIncluded”
maintenanceConfigurationId	指定要应用于此托管实例的维护配置 ID。	字符串
managedInstanceCreateMode	指定数据库创建模式。默认值：定期创建实例。还原：通过将一组备份还原到特定时间点来创建实例。必须指定 RestorePointInTime 和 SourceManagedInstanceId。	'Default' “PointInTimeRestore”
minimalTlsVersion	最低 TLS 版本。允许的值：“None”、“1.0”、“1.1”、“1.2”	字符串
primaryUserAssignedIdentityId	默认要使用的用户分配标识的资源 ID。	字符串
proxyOverride	用于连接到实例的连接类型。	'Default' 'Proxy' “重定向”
publicDataEndpointEnabled	是否启用公共数据终结点。	bool
restorePointInTime	指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。	字符串
sourceManagedInstanceId	与此实例的创建操作关联的源托管实例的资源标识符。	字符串
storageAccountType	用于存储此实例的备份的存储帐户类型。选项包括 LRS (LocallyRedundantStorage) 、ZRS (ZoneRedundantStorage) 和 GRS (GeoRedundantStorage)	'GRS' 'LRS' 'ZRS'
storageSizeInGB	存储大小（以 GB 为单位）。最小值：32。最大值：8192。仅允许 32 GB 的增量。	int
subnetId	托管实例的子网资源 ID。	字符串
timezoneId	时区的 ID。允许的值是 Windows 支持的时区。 Windows 在注册表中保留有关受支持时区（包括 ID）的详细信息 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones。可以通过SQL Server查询 SELECT name AS timezone_id FROM sys.time_zone_info 来获取这些注册表值。还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]：：GetSystemTimeZones () 来获取 ID 列表。有效时区 ID 的示例是“太平洋标准时间”或“W”。欧洲标准时间”。	字符串
vCore 数	vCore 数。允许的值：8、16、24、32、40、64、80。	int
zoneRedundant	是否启用了 multi-az。	bool

ManagedInstanceExternalAdministrator

名称	说明	值
administratorType	服务器管理员的类型。	“ActiveDirectory”
azureADOnlyAuthentication	已启用“仅限 Azure Active Directory 身份验证”。	bool
login	服务器管理员的登录名。	字符串
principalType	服务器管理员的主体类型。	“Application” 'Group' “User”
sid	SID (服务器管理员的对象 ID) 。	字符串约束：最小长度 = 36 最大长度 = 36 模式 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
tenantId	管理员的租户 ID。	字符串约束：最小长度 = 36 最大长度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

SKU

名称	说明	值
容量	特定 SKU 的容量。	int
family	如果服务具有不同代系的硬件（对于同一 SKU），则可以在此处进行捕获。	字符串
name	SKU 的名称，通常为字母 + 数字代码，例如 P3。	字符串 (必需)
大小	特定 SKU 的大小	字符串
层	特定 SKU 的层或版本，例如“基本”、“高级”。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用网络部署SQL 托管实例	部署 UDR 和 NSG 以支持Azure SQL 托管实例和部署托管实例
在新虚拟网络内创建 SQL MI	在新虚拟网络内部署 Azure Sql 数据库托管实例 (SQL MI) 。
使用配置的日志和指标发送创建 SQL MI	通过此模板，可以部署用于存储诊断工作区、存储帐户、事件中心) (日志和指标的 SQL MI 和其他资源。
在新虚拟网络中使用 jumpbox 创建 SQL MI	在新虚拟网络内使用 SSMS 部署 Azure Sql 数据库托管实例 (SQL MI) 和 JumpBox。
创建配置了点到站点连接的 SQL MI	托管实例 (为新虚拟网络中的点到站点连接配置的 SQL MI) 和虚拟网络网关部署 Azure Sql 数据库。

ARM 模板资源定义

managedInstances 资源类型可以通过针对以下操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Sql/managedInstances 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Sql/managedInstances",
  "apiVersion": "2021-02-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "administrators": {
      "administratorType": "ActiveDirectory",
      "azureADOnlyAuthentication": "bool",
      "login": "string",
      "principalType": "string",
      "sid": "string",
      "tenantId": "string"
    },
    "collation": "string",
    "dnsZonePartner": "string",
    "instancePoolId": "string",
    "keyId": "string",
    "licenseType": "string",
    "maintenanceConfigurationId": "string",
    "managedInstanceCreateMode": "string",
    "minimalTlsVersion": "string",
    "primaryUserAssignedIdentityId": "string",
    "proxyOverride": "string",
    "publicDataEndpointEnabled": "bool",
    "restorePointInTime": "string",
    "sourceManagedInstanceId": "string",
    "storageAccountType": "string",
    "storageSizeInGB": "int",
    "subnetId": "string",
    "timezoneId": "string",
    "vCores": "int",
    "zoneRedundant": "bool"
  }
}

属性值

managedInstances

名称	说明	Value
type	资源类型	“Microsoft.Sql/managedInstances”
apiVersion	资源 API 版本	“2021-02-01-preview”
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：小写字母、数字和连字符。不能以连字符开头或结尾。资源名称在 Azure 中必须是唯一的。
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
sku	托管实例 SKU。 sku.name 允许的值：GP_Gen4、GP_Gen5、BC_Gen4、BC_Gen5	Sku
标识	托管实例的 Azure Active Directory 标识。	ResourceIdentity
properties	资源属性。	ManagedInstanceProperties

ResourceIdentity

名称	说明	Value
type	标识类型。将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	要使用的用户分配标识的资源 ID	ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		UserIdentity

UserIdentity

此对象不包含部署期间要设置的任何属性。所有属性均为 ReadOnly。

ManagedInstanceProperties

名称	说明	值
administratorLogin	托管实例的管理员用户名。仅当 (创建托管实例并且需要创建) 时指定。	字符串
administratorLoginPassword	创建托管实例) (管理员登录密码。	字符串
管理员	服务器的 Azure Active Directory 管理员。	ManagedInstanceExternalAdministrator
collation	托管实例的排序规则。	字符串
dnsZonePartner	另一个托管实例的资源 ID，该托管实例在创建后将共享其 DNS 区域。	字符串
instancePoolId	此托管服务器所属的实例池的 ID。	字符串
keyId	要用于加密的密钥的 CMK URI。	字符串
LicenseType	许可证类型。可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格，“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。	“BasePrice” “LicenseIncluded”
maintenanceConfigurationId	指定要应用于此托管实例的维护配置 ID。	字符串
managedInstanceCreateMode	指定数据库创建模式。默认值：定期创建实例。还原：通过将一组备份还原到特定时间点来创建实例。必须指定 RestorePointInTime 和 SourceManagedInstanceId。	'Default' “PointInTimeRestore”
minimalTlsVersion	最低 TLS 版本。允许的值：“None”、“1.0”、“1.1”、“1.2”	字符串
primaryUserAssignedIdentityId	默认要使用的用户分配标识的资源 ID。	字符串
proxyOverride	用于连接到实例的连接类型。	'Default' 'Proxy' “重定向”
publicDataEndpointEnabled	是否启用公共数据终结点。	bool
restorePointInTime	指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。	字符串
sourceManagedInstanceId	与此实例的创建操作关联的源托管实例的资源标识符。	字符串
storageAccountType	用于存储此实例的备份的存储帐户类型。选项包括 LRS (LocallyRedundantStorage) 、ZRS (ZoneRedundantStorage) 和 GRS (GeoRedundantStorage)	'GRS' 'LRS' 'ZRS'
storageSizeInGB	存储大小（以 GB 为单位）。最小值：32。最大值：8192。仅允许 32 GB 的增量。	int
subnetId	托管实例的子网资源 ID。	字符串
timezoneId	时区的 ID。允许的值是 Windows 支持的时区。 Windows 在注册表中保留有关受支持时区（包括 ID）的详细信息 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones。可以通过SQL Server查询 SELECT name AS timezone_id FROM sys.time_zone_info 来获取这些注册表值。还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]：：GetSystemTimeZones () 来获取 ID 列表。有效时区 ID 的示例是“太平洋标准时间”或“W”。欧洲标准时间”。	字符串
vCore 数	vCore 数。允许的值：8、16、24、32、40、64、80。	int
zoneRedundant	是否启用 multi-az。	bool

ManagedInstanceExternalAdministrator

名称	说明	值
administratorType	服务器管理员的类型。	“ActiveDirectory”
azureADOnlyAuthentication	已启用仅限 Azure Active Directory 身份验证。	bool
login	服务器管理员的登录名。	字符串
principalType	服务器管理员的主体类型。	“应用程序” “组” “User”
sid	SID (服务器管理员的对象 ID) 。	字符串约束：最小长度 = 36 最大长度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
tenantId	管理员的租户 ID。	字符串约束：最小长度 = 36 最大长度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

SKU

名称	说明	值
容量	特定 SKU 的容量。	int
family	如果服务具有不同代系的硬件（对于同一 SKU），则可以在此处进行捕获。	字符串
name	SKU 的名称，通常为字母 + 数字代码，例如 P3。	字符串 (必需)
大小	特定 SKU 的大小	字符串
层	特定 SKU 的层或版本，例如“基本”、“高级”。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用网络部署SQL 托管实例	部署 UDR 和 NSG 以支持Azure SQL 托管实例和部署托管实例
在新虚拟网络内创建 SQL MI	在新虚拟网络内部署 Azure Sql 数据库托管实例 (SQL MI) 。
使用配置的日志和指标发送创建 SQL MI	通过此模板，可以部署用于存储诊断工作区、存储帐户、事件中心) (日志和指标的 SQL MI 和其他资源。
在新虚拟网络中使用 jumpbox 创建 SQL MI	在新虚拟网络内使用 SSMS 部署 Azure Sql 数据库托管实例 (SQL MI) 和 JumpBox。
创建配置了点到站点连接的 SQL MI	托管实例 (为新虚拟网络中的点到站点连接配置的 SQL MI) 和虚拟网络网关部署 Azure Sql 数据库。

Terraform (AzAPI 提供程序) 资源定义

managedInstances 资源类型可以通过针对以下操作进行部署：

资源组

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Sql/managedInstances 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/managedInstances@2021-02-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      administrators = {
        administratorType = "ActiveDirectory"
        azureADOnlyAuthentication = bool
        login = "string"
        principalType = "string"
        sid = "string"
        tenantId = "string"
      }
      collation = "string"
      dnsZonePartner = "string"
      instancePoolId = "string"
      keyId = "string"
      licenseType = "string"
      maintenanceConfigurationId = "string"
      managedInstanceCreateMode = "string"
      minimalTlsVersion = "string"
      primaryUserAssignedIdentityId = "string"
      proxyOverride = "string"
      publicDataEndpointEnabled = bool
      restorePointInTime = "string"
      sourceManagedInstanceId = "string"
      storageAccountType = "string"
      storageSizeInGB = int
      subnetId = "string"
      timezoneId = "string"
      vCores = int
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

属性值

managedInstances

名称	说明	Value
type	资源类型	“Microsoft.Sql/managedInstances@2021-02-01-preview”
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：小写字母、数字和连字符。不能以连字符开头或结尾。资源名称在 Azure 中必须是唯一的。
location	资源位置。	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
sku	托管实例 SKU。 sku.name 允许的值：GP_Gen4、GP_Gen5、BC_Gen4、BC_Gen5	Sku
标识	托管实例的 Azure Active Directory 标识。	ResourceIdentity
properties	资源属性。	ManagedInstanceProperties

ResourceIdentity

名称	说明	Value
type	标识类型。将其设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
identity_ids	要使用的用户分配标识的资源 ID	用户标识 ID 的数组。

ResourceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		UserIdentity

UserIdentity

此对象不包含部署期间要设置的任何属性。所有属性均为 ReadOnly。

ManagedInstanceProperties

名称	说明	值
administratorLogin	托管实例的管理员用户名。仅当 (创建托管实例并且需要创建) 时指定。	字符串
administratorLoginPassword	创建托管实例) (管理员登录密码。	字符串
管理员	服务器的 Azure Active Directory 管理员。	ManagedInstanceExternalAdministrator
collation	托管实例的排序规则。	字符串
dnsZonePartner	另一个托管实例的资源 ID，该托管实例在创建后将共享其 DNS 区域。	字符串
instancePoolId	此托管服务器所属的实例池的 ID。	字符串
keyId	要用于加密的密钥的 CMK URI。	字符串
LicenseType	许可证类型。可能的值为“LicenseIncluded” (包含新 SQL 许可证) 的常规价格，“BasePrice” (将自己的 SQL 许可证) 的折扣 AHB 价格。	“BasePrice” “LicenseIncluded”
maintenanceConfigurationId	指定要应用于此托管实例的维护配置 ID。	字符串
managedInstanceCreateMode	指定数据库创建模式。默认值：定期创建实例。还原：通过将一组备份还原到特定时间点来创建实例。必须指定 RestorePointInTime 和 SourceManagedInstanceId。	“Default” “PointInTimeRestore”
minimalTlsVersion	最低 TLS 版本。允许的值：“None”、“1.0”、“1.1”、“1.2”	字符串
primaryUserAssignedIdentityId	默认要使用的用户分配标识的资源 ID。	字符串
proxyOverride	用于连接到实例的连接类型。	“Default” “代理” “重定向”
publicDataEndpointEnabled	是否启用公共数据终结点。	bool
restorePointInTime	指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。	字符串
sourceManagedInstanceId	与此实例的创建操作关联的源托管实例的资源标识符。	字符串
storageAccountType	用于存储此实例的备份的存储帐户类型。选项包括 LRS (LocallyRedundantStorage) 、ZRS (ZoneRedundantStorage) 和 GRS (GeoRedundantStorage)	“GRS” “LRS” “ZRS”
storageSizeInGB	存储大小（以 GB 为单位）。最小值：32。最大值：8192。仅允许 32 GB 的增量。	int
subnetId	托管实例的子网资源 ID。	字符串
timezoneId	时区的 ID。允许的值是 Windows 支持的时区。 Windows 在注册表中保留有关受支持时区（包括 ID）的详细信息 KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones。可以通过SQL Server查询 SELECT name AS timezone_id FROM sys.time_zone_info 来获取这些注册表值。还可以通过在 PowerShell 中执行 [System.TimeZoneInfo]：：GetSystemTimeZones () 来获取 ID 列表。有效时区 ID 的示例是“太平洋标准时间”或“W”。欧洲标准时间”。	字符串
vCore 数	vCore 数。允许的值：8、16、24、32、40、64、80。	int
zoneRedundant	是否启用了 multi-az。	bool

ManagedInstanceExternalAdministrator

名称	说明	值
administratorType	服务器管理员的类型。	“ActiveDirectory”
azureADOnlyAuthentication	已启用“仅限 Azure Active Directory 身份验证”。	bool
login	服务器管理员的登录名。	字符串
principalType	服务器管理员的主体类型。	"Application" “Group” “User”
sid	SID (服务器管理员的对象 ID) 。	字符串约束：最小长度 = 36 最大长度 = 36 模式 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
tenantId	管理员的租户 ID。	字符串约束：最小长度 = 36 最大长度 = 36 模式 = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

SKU

名称	说明	值
容量	特定 SKU 的容量。	int
family	如果服务针对同一 SKU 具有不同代系的硬件，则可以在此处捕获。	字符串
name	SKU 的名称，通常为字母 + 数字代码，例如 P3。	字符串 (必需)
大小	特定 SKU 的大小	字符串
层	特定 SKU 的层或版本，例如基本 SKU、高级 SKU。	字符串

通过

Microsoft.Sql managedInstances 2021-02-01-preview

Bicep 资源定义

资源格式

属性值

managedInstances

ResourceIdentity

ResourceIdentityUserAssignedIdentities

UserIdentity

ManagedInstanceProperties

ManagedInstanceExternalAdministrator

SKU

快速入门模板

ARM 模板资源定义

资源格式

属性值

managedInstances

ResourceIdentity

ResourceIdentityUserAssignedIdentities

UserIdentity

ManagedInstanceProperties

ManagedInstanceExternalAdministrator

SKU

快速入门模板

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

managedInstances

ResourceIdentity

ResourceIdentityUserAssignedIdentities

UserIdentity

ManagedInstanceProperties

ManagedInstanceExternalAdministrator

SKU

其他资源