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

Managed Instances - List By Resource Group

获取资源组中的托管实例的列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances?api-version=2022-02-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances?$expand={$expand}&api-version=2022-02-01-preview

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

subscriptionId
path True
  • string

用于标识 Azure 订阅的订阅 ID。

api-version
query True
  • string

要用于请求的 API 版本。

$expand
query
  • string

要包含在响应中的子资源。

响应

Name Type Description
200 OK

已成功检索托管实例的列表。

Other Status Codes

错误响应: ***

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy - 对于具有 LRS/ZRS 备份存储冗余的托管实例,不允许Geo-Restore。

  • 400 UpdateingInstanceAndBackupRedundancy - 实例区域冗余和备份存储冗余不能在同一请求中更新。

  • 400 ProvisioningDisabled - 按原样显示资源操作授权者的错误消息,无需更改

  • 400 AadOnlyAuthenticationIsEnabled - 已启用 Azure Active Directory 仅身份验证。 请联系你的系统管理员。

  • 400 ManagementServiceFeatureDisabled - 用户尝试使用禁用的功能。

  • 404 SubscriptionNotFound - 找不到请求的订阅。

  • 404 ServerNotInSubscription - 指定的服务器在指定的订阅上不存在。

  • 404 ManagedInstanceNotInSubscriptionResourceGroup - 指定的托管实例在指定的资源组和订阅中不存在。

  • 404 SubscriptionNotFound - 找不到请求的订阅。

  • 404 ResourceNotFound - 找不到请求的资源。

  • 409 ConflictingManagedInstanceOperation - 托管实例当前正在进行操作。

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - 实例为多 az,但备份存储正在从区域冗余更新到非区域冗余。

  • 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - 无法更新实例冗余,因为备份存储冗余更新正在进行中。

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - 备份存储是非区域冗余的,但实例冗余正在更新为区域冗余。

  • 409 BackupRedundancyUpdateConflict - 无法更新备份存储冗余,因为备份存储冗余更新正在进行中。

  • 409 MiDropFailedOnAuthLocks - 用户尝试删除子网中应用了锁定 () 的子网中的最后一个托管实例。

  • 409 MiCreateFailedNonDelegatedSubnet - 用户尝试在未委托给 Microsoft.Sql/managedInstances 的子网中部署托管实例或托管实例池。

  • 412 InstanceNotReadyForBackupRedundancyUpdate - 无法更新备份存储冗余,因为实例尚未准备就绪。

  • 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。

  • 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。

  • 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。

  • 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。

  • 429 ConflictingSubscriptionOperation - 订阅当前正在进行操作。

  • 503 TooManyRequests - 请求超出可用资源可处理的最大请求数。

  • 503 TooManyRequests - 请求超出可用资源可处理的最大请求数。

  • 504 RequestTimeout - 服务请求超出了允许的超时。

  • 504 RequestTimeout - 服务请求超出了允许的超时。

示例

List managed instances by resource group
List managed instances by resource group with $expand=administrators/activedirectory

List managed instances by resource group

Sample Request

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances?api-version=2022-02-01-preview

Sample Response

{
  "value": [
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen4",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 8,
        "storageSizeInGB": 1024,
        "licenseType": "LicenseIncluded",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "1b4e2caff2530",
        "maintenanceConfigurationId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    },
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "BC_Gen5",
        "tier": "BusinessCritical",
        "capacity": 16,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "2c3d1bdae3412",
        "maintenanceConfigurationId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    }
  ]
}

List managed instances by resource group with $expand=administrators/activedirectory

Sample Request

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances?api-version=2022-02-01-preview

Sample Response

{
  "value": [
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen4",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 8,
        "storageSizeInGB": 1024,
        "licenseType": "LicenseIncluded",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "1b4e2caff2530",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        }
      }
    },
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "BC_Gen5",
        "tier": "BusinessCritical",
        "capacity": 16,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "2c3d1bdae3412",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_2",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        }
      }
    }
  ]
}

定义

AdministratorType

服务器管理员的类型。

BackupStorageRedundancy

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

IdentityType

标识类型。 将此设置为“SystemAssigned”,以便为资源自动创建和分配 Azure Active Directory 主体。

ManagedInstance

Azure SQL托管实例。

ManagedInstanceExternalAdministrator

Active Directory 管理员的属性。

ManagedInstanceLicenseType

许可证类型。 可能的值为“LicenseIncluded”, (常规价格,包括新的 SQL 许可证) 和“BasePrice” (折扣的 AHB 价格,用于自带 SQL 许可证) 。

ManagedInstanceListResult

托管实例的列表。

ManagedInstancePecProperty

托管实例下的专用终结点连接

ManagedInstancePrivateEndpointConnectionProperties

专用终结点连接的属性。

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

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

ManagedServerCreateMode

指定数据库创建模式。

默认值:定期创建实例。

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

PrincipalType

服务器管理员的主体类型。

ResourceIdentity

资源的 Azure Active Directory 标识配置。

ServicePrincipal

托管实例的服务主体配置资源。

ServicePrincipalType

服务主体类型。

Sku

ARM 资源 SKU。

UserIdentity

资源的 Azure Active Directory 标识配置。

AdministratorType

服务器管理员的类型。

Name Type Description
ActiveDirectory
  • string

BackupStorageRedundancy

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

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

IdentityType

标识类型。 将此设置为“SystemAssigned”,以便为资源自动创建和分配 Azure Active Directory 主体。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ManagedInstance

Azure SQL托管实例。

Name Type Description
id
  • string

资源 ID。

identity

托管实例的 Azure Active Directory 标识。

location
  • string

资源位置。

name
  • string

资源名称。

properties.administratorLogin
  • string

托管实例的管理员用户名。 只能在创建托管实例 (且创建) 时指定。

properties.administratorLoginPassword
  • string

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

properties.administrators

服务器的 Azure Active Directory 管理员。

properties.collation
  • string

托管实例的排序规则。

properties.currentBackupStorageRedundancy

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

properties.dnsZone
  • string

托管实例位于的 Dns 区域。

properties.dnsZonePartner
  • string

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

properties.fullyQualifiedDomainName
  • string

托管实例的完全限定域名。

properties.instancePoolId
  • string

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

properties.keyId
  • string

要用于加密的密钥的 CMK URI。

properties.licenseType

许可证类型。 可能的值为“LicenseIncluded”, (常规价格,包括新的 SQL 许可证) 和“BasePrice” (折扣的 AHB 价格,用于自带 SQL 许可证) 。

properties.maintenanceConfigurationId
  • string

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

properties.managedInstanceCreateMode

指定数据库创建模式。

默认值:定期创建实例。

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

properties.minimalTlsVersion
  • string

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

properties.primaryUserAssignedIdentityId
  • string

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

properties.privateEndpointConnections

托管实例上的专用终结点连接列表。

properties.provisioningState enum:
  • Accepted
  • Canceled
  • Created
  • Creating
  • Deleted
  • Deleting
  • Failed
  • NotSpecified
  • Registering
  • Running
  • Succeeded
  • TimedOut
  • Unknown
  • Unrecognized
  • Updating
properties.proxyOverride

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

properties.publicDataEndpointEnabled
  • boolean

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

properties.requestedBackupStorageRedundancy

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

properties.restorePointInTime
  • string

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

properties.servicePrincipal

托管实例的服务主体。

properties.sourceManagedInstanceId
  • string

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

properties.state
  • string

托管实例的状态。

properties.storageSizeInGB
  • integer

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

properties.subnetId
  • string

托管实例的子网资源 ID。

properties.timezoneId
  • string

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

properties.vCores
  • integer

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

properties.zoneRedundant
  • boolean

是否启用 multi-az。

sku

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

tags
  • object

资源标记。

type
  • string

资源类型。

ManagedInstanceExternalAdministrator

Active Directory 管理员的属性。

Name Type Description
administratorType

服务器管理员的类型。

azureADOnlyAuthentication
  • boolean

仅启用 Azure Active Directory 身份验证。

login
  • string

服务器管理员的登录名。

principalType

服务器管理员的主体类型。

sid
  • string

服务器管理员) SID (对象 ID。

tenantId
  • string

管理员的租户 ID。

ManagedInstanceLicenseType

许可证类型。 可能的值为“LicenseIncluded”, (常规价格,包括新的 SQL 许可证) 和“BasePrice” (折扣的 AHB 价格,用于自带 SQL 许可证) 。

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

ManagedInstanceListResult

托管实例的列表。

Name Type Description
nextLink
  • string

用于检索下一页结果的链接。

value

结果数组。

ManagedInstancePecProperty

托管实例下的专用终结点连接

Name Type Description
id
  • string

资源 ID。

properties

专用终结点连接属性

ManagedInstancePrivateEndpointConnectionProperties

专用终结点连接的属性。

Name Type Description
privateEndpoint

连接所属的专用终结点。

privateLinkServiceConnectionState

专用终结点连接的连接状态。

provisioningState
  • string

专用终结点连接的状态。

ManagedInstancePrivateEndpointProperty

Name Type Description
id
  • string

专用终结点的资源 ID。

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Type Description
actionsRequired
  • string

专用链接服务连接说明。

description
  • string

专用链接服务连接说明。

status
  • string

专用链接服务连接状态。

ManagedInstanceProxyOverride

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

Name Type Description
Default
  • string
Proxy
  • string
Redirect
  • string

ManagedServerCreateMode

指定数据库创建模式。

默认值:定期创建实例。

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

Name Type Description
Default
  • string
PointInTimeRestore
  • string

PrincipalType

服务器管理员的主体类型。

Name Type Description
Application
  • string
Group
  • string
User
  • string

ResourceIdentity

资源的 Azure Active Directory 标识配置。

Name Type Description
principalId
  • string

Azure Active Directory 主体 ID。

tenantId
  • string

Azure Active Directory 租户 ID。

type

标识类型。 将此设置为“SystemAssigned”,以便自动为资源创建和分配 Azure Active Directory 主体。

userAssignedIdentities

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

ServicePrincipal

托管实例的服务主体配置资源。

Name Type Description
clientId
  • string

Azure Active Directory 应用程序客户端 ID。

principalId
  • string

Azure Active Directory 应用程序对象 ID。

tenantId
  • string

Azure Active Directory 租户 ID。

type

服务主体类型。

ServicePrincipalType

服务主体类型。

Name Type Description
None
  • string
SystemAssigned
  • string

Sku

ARM 资源 SKU。

Name Type Description
capacity
  • integer

特定 SKU 的容量。

family
  • string

如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。

name
  • string

SKU 的名称,通常为字母 + 数字代码,例如 P3。

size
  • string

特定 SKU 的大小

tier
  • string

特定 SKU 的层或版本,例如基本版、高级版。

UserIdentity

资源的 Azure Active Directory 标识配置。

Name Type Description
clientId
  • string

Azure Active Directory 客户端 ID。

principalId
  • string

Azure Active Directory 主体 ID。