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

Instance Pools - List

获取订阅中所有实例池的列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/instancePools?api-version=2025-01-01

URI 参数

名称 在 必需 类型 说明
subscriptionId
path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

minLength: 1

用于此作的 API 版本。

响应

名称 类型 说明
200 OK

InstancePoolListResult

Azure 运营顺利完成。

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

List instance pools in the subscription

示例请求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/instancePools?api-version=2025-01-01

示例响应

{
  "value": [
    {
      "name": "testIP",
      "type": "Microsoft.Sql/instancePools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP",
      "location": "japaneast",
      "properties": {
        "dnsZone": "1234567890",
        "licenseType": "LicenseIncluded",
        "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
        "vCores": 8
      },
      "sku": {
        "name": "GP_Gen5",
        "family": "Gen5",
        "tier": "GeneralPurpose"
      },
      "tags": {
        "a": "b"
      }
    },
    {
      "name": "testIP2",
      "type": "Microsoft.Sql/instancePools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group2/providers/Microsoft.Sql/instancePools/testIP2",
      "location": "japaneast",
      "properties": {
        "dnsZone": "1234567890",
        "licenseType": "LicenseIncluded",
        "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group2/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
        "vCores": 8
      },
      "sku": {
        "name": "GP_Gen5",
        "family": "Gen5",
        "tier": "GeneralPurpose"
      },
      "tags": {
        "a": "b"
      }
    }
  ]
}

定义

名称 说明
createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

InstancePool

An Azure SQL instance pool.

InstancePoolLicenseType

许可证类型。 可能的值为“LicenseIncluded”(包括 SQL 许可证的价格)和“BasePrice”(不含 SQL 许可证价格)。

InstancePoolListResult

InstancePool 列表操作的响应。

Sku

ARM 资源 SKU。

systemData

与创建和上次修改资源相关的元数据。

createdByType

创建资源的标识的类型。

值 说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

附加信息。

type

string

附加信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

InstancePool

An Azure SQL instance pool.

名称 类型 说明
id

string (arm-id)

资源的完全限定资源 ID。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

location

string

资源所在的地理位置

name

string

资源的名称

properties.dnsZone

string

托管实例池位于的 Dns 区域。

properties.licenseType

InstancePoolLicenseType

许可证类型。 可能的值为“LicenseIncluded”(包括 SQL 许可证的价格)和“BasePrice”(不含 SQL 许可证价格)。

properties.maintenanceConfigurationId

string (arm-id)

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

properties.subnetId

string

要在其中放置此实例池的子网的资源 ID。

properties.vCores

integer (int32)

属于此实例池的 vCore 计数。

sku

Sku

SKU 的名称和层。

systemData

systemData

Azure 资源管理器 包含 createdBy 和 modifiedBy 信息的元数据。

tags

object

资源标记。

type

string

资源类型。 例如,“Microsoft。计算/虚拟机“或”Microsoft“。存储/存储账户”

InstancePoolLicenseType

许可证类型。 可能的值为“LicenseIncluded”(包括 SQL 许可证的价格)和“BasePrice”(不含 SQL 许可证价格)。

值 说明
LicenseIncluded

包含许可

BasePrice

BasePrice

InstancePoolListResult

InstancePool 列表操作的响应。

名称 类型 说明
nextLink

string (uri)

指向下一页项的链接

value

InstancePool[]

本页的InstancePool项目

Sku

ARM 资源 SKU。

名称 类型 说明
capacity

integer (int32)

特定 SKU 的容量。

family

string

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

name

string

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

size

string

特定 SKU 的大小

tier

string

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

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。