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

Elastic Pools - Get

参考

服务:: SQL Database

API 版本:: 2021-11-01

获取弹性池。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}?api-version=2021-11-01

URI 参数

名称	在	必需	类型	说明
elasticPoolName	path	True	string	弹性池的名称。
resourceGroupName	path	True	string	包含该资源的资源组名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	用于标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	ElasticPool	已成功
Other Status Codes		错误响应： *** 400 ElasticPoolOverStorageUsage - 尝试在达到弹性池的存储限制时将数据写入数据库。 400 InvalidSku - 用户指定的 SKU 无效。 400 InvalidTierSkuCombination - 指定的层不支持指定的 SKU。 400 ServerQuotaExceeded - 服务器达到了允许的数据库吞吐量单位的限制。 400 ElasticPoolAlreadyExists - 服务器已包含具有指定名称的弹性池。 400 SubscriptionVcoreQuotaExceeded - 无法执行操作，因为订阅将超过允许的 vCore 配额。 400 InvalidInputValueForEdition - 弹性池预配不支持指定版本。 400 ElasticPoolDtuBelowLimit - 请求的 DTU 值对于请求的弹性池服务层太低。 400 ElasticPoolDtuAboveLimit - 请求的 DTU 值对于请求的弹性池服务层来说太高。 400 InvalidMaxSize - 最大大小无效。 400 ElasticPoolDbDtuMaxBelowLimit - 每个数据库请求的 DTU 最大值对于所请求的弹性池服务层太低。 400 ElasticPoolDbDtuMaxAboveLimit - 对于所请求的弹性池服务层而言，每个数据库请求的 DTU 最大值过高。 400 InvalidInputValueForDatabaseDtuMax - 尝试为与允许值不匹配的资源池设置每个数据库的 DTU 最大值。 400 ElasticPoolDbDtuMinAboveLimit - 每个数据库请求的 DTU 最小值对于请求的服务层而言过高。 400 ElasticPoolOverStorage - 在达到弹性池的存储限制时尝试将数据写入数据库。 400 InvalidInputValueForDatabaseDtuMin - 尝试为与允许的值不匹配的资源池设置每个数据库的 DTU 最小值。 400 ElasticPoolInconsistentDtuGuaranteeSettings - 尝试为超过弹性池请求的 DTU 的数据库提供 DTU 最小值。 400 ElasticPoolDtuUnsupported - 用户尝试使用不支持的 DTU 容量创建或更新弹性池。 400 ElasticPoolStorageAboveLimitGB - 尝试将弹性池存储限制设置为低于支持的限制。 400 ElasticPoolsNotEnabled - 尚未在此区域中启用弹性池。 400 ElasticPoolNotEmpty - 请求删除不为空的弹性池。 400 ElasticPoolStorageBelowLimitGB - 尝试将弹性池存储限制设置为低于支持的限制。 400 ElasticPoolStorageNotAllowedGB - 尝试设置与允许值不匹配的弹性池存储限制（以 gb 为单位）。 400 ElasticPoolDatabaseLimit - 弹性池已达到数据库数限制。 400 ElasticPoolDecreaseStorageLimitBelowUsage - 尝试将弹性池的存储限制降低到其存储使用量以下。 400 InvalidInputValueDatabaseDtuMinLargerThanMax - 尝试将每个数据库的 DTU 最小值设置为高于每个数据库的 DTU 最大值。 400 ElasticPoolInconsistentVcoreGuaranteeSettings - 数据库数和每个数据库的 VCore 最小值不能超过弹性池请求的 VCore 数。 400 ElasticPoolStorageBelowLimitMB - 尝试将弹性池存储限制设置为低于支持的限制。 400 ElasticPoolStorageNotAllowedMB - 尝试设置与允许值不匹配的弹性池存储限制（以 mb 为单位）。 400 ElasticPoolCapacityStorageNotAllowedMB - 尝试设置与允许值不匹配的弹性池存储限制（以 mb 为单位）。 400 ElasticPoolStorageAboveLimitMB - 尝试将弹性池存储限制设置为低于支持的限制。 400 RegionDoesNotSupportVersion - 用户尝试在不支持该服务器版本的位置创建指定版本的服务器。 400 InvalidTier - 用户指定的层无效。 400 SourceDatabaseEditionCouldNotBeUpgraded - 源数据库的版本不能高于目标数据库。 400 TargetDatabaseEditionCouldNotBeDowngraded - 目标数据库的版本不能低于源数据库。 400 ElasticPoolUpdateHkNotAllowed - 弹性池无法将其服务层级从“高级”降低到“标准”或“基本”，因为其一个或多个数据库使用内存优化对象。 400 UpdateNotAllowedIfGeoDrOperationInProgress - 不允许该操作，因为服务器“”{1}上数据库“”{0}的复制或故障转移操作当前正在进行。 400 RegionDoesNotAllowProvisioning - 所选位置不接受新的 Windows Azure SQL数据库服务器。这可能会在以后更改。 400 ElasticPoolOverFileSpace - 弹性池中的文件空间不足。 400 ElasticPoolDbDtuMinBelowLimit - 每个数据库请求的 DTU 最小值对于所请求的弹性池服务层太低。 400 ElasticPoolDbVcoreMaxBelowLimit - 对于所请求的弹性池服务层而言，每个数据库 VCore 请求的最大值太低。 400 ElasticPoolDbVcoreMaxAboveLimit - 对于所请求的弹性池服务层而言，每个数据库 VCore 请求的最大值过高。 400 InvalidInputValueForDatabaseVcoreMax - 尝试为与允许值不匹配的资源池设置每个数据库的 VCore 最大值。 400 ElasticPoolDbVcoreMinBelowLimit - 对于所请求的弹性池服务层而言，每个数据库 VCore 的最小值太低。 400 InvalidInputValueForDatabaseVcoreMin - 尝试为与允许的值不匹配的资源池设置每个数据库的 VCore 最小值。 400 PartnerDBNotCompatibleForSGXEnclave - 仅当两个数据库都在 DC 系列硬件上运行时，才支持尝试为已启用 enclave 的数据库设置 GeoDR 链接或更新 SLO。 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - 尝试将每个数据库的 VCore 最小值设置为高于每个数据库的 VCore 最大值。 400 InvalidLicenseType - 用户尝试使用不受支持的许可证类型创建或更新数据库或弹性池。 400 ProvisioningDisabled - 按原样显示来自资源操作授权者的错误消息，不需更改 400 InvalidPublicMaintenanceConfiguration - 用户尝试指定无法转换为内部 ID 的公共维护配置， (格式不正确或错误的区域) 。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 ServerNotInSubscriptionResourceGroup - 指定的服务器不存在于指定的资源组和订阅中。 404 ElasticPoolNotFound - 指定的服务器不存在指定的弹性池。 404 OperationIdNotFound - ID 为的操作不存在。 404 ResourceNotFound - 找不到请求的资源。 405 NotSupported - 不支持此功能。 409 ElasticPoolBusy - 在忙的弹性池上尝试了管理操作。 409 ServerDisabled - 服务器已禁用。 409 SimultaneousSkuChangeNotAllowed - 服务目标更改操作不能同时在复制关系的两个数据库上运行。 409 ElasticPoolUpdateLinksNotInCatchup - 当其中一个数据库正在执行复制或异地复制故障转移操作时，无法更新弹性池。 409 OperationCancelled - 用户已取消该操作。 409 操作中断 - 无法完成对资源的操作，因为它被同一资源上的另一个操作中断。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用资源可处理的最大请求数的请求数。 429 SubscriptionTooManyRequests - 超出可用资源可处理的最大请求数的请求数。 500 ElasticPoolFailedMoveDbToElasticPool - 由于内部资源约束，无法将数据库移动到弹性池。这可能是暂时性的情况，请重试。 500 OperationTimedOut - 操作超时并自动回滚。请重试该操作。 503 ServiceTemporarilyUnavailable - 功能暂时不可用。 503 TooManyRequests - 超出可用资源可处理的最大请求数的请求数。

名称

类型

说明

200 OK

ElasticPool

已成功

Other Status Codes

错误响应： ***

400 ElasticPoolOverStorageUsage - 尝试在达到弹性池的存储限制时将数据写入数据库。
400 InvalidSku - 用户指定的 SKU 无效。
400 InvalidTierSkuCombination - 指定的层不支持指定的 SKU。
400 ServerQuotaExceeded - 服务器达到了允许的数据库吞吐量单位的限制。
400 ElasticPoolAlreadyExists - 服务器已包含具有指定名称的弹性池。
400 SubscriptionVcoreQuotaExceeded - 无法执行操作，因为订阅将超过允许的 vCore 配额。
400 InvalidInputValueForEdition - 弹性池预配不支持指定版本。
400 ElasticPoolDtuBelowLimit - 请求的 DTU 值对于请求的弹性池服务层太低。
400 ElasticPoolDtuAboveLimit - 请求的 DTU 值对于请求的弹性池服务层来说太高。
400 InvalidMaxSize - 最大大小无效。
400 ElasticPoolDbDtuMaxBelowLimit - 每个数据库请求的 DTU 最大值对于所请求的弹性池服务层太低。
400 ElasticPoolDbDtuMaxAboveLimit - 对于所请求的弹性池服务层而言，每个数据库请求的 DTU 最大值过高。
400 InvalidInputValueForDatabaseDtuMax - 尝试为与允许值不匹配的资源池设置每个数据库的 DTU 最大值。
400 ElasticPoolDbDtuMinAboveLimit - 每个数据库请求的 DTU 最小值对于请求的服务层而言过高。
400 ElasticPoolOverStorage - 在达到弹性池的存储限制时尝试将数据写入数据库。
400 InvalidInputValueForDatabaseDtuMin - 尝试为与允许的值不匹配的资源池设置每个数据库的 DTU 最小值。
400 ElasticPoolInconsistentDtuGuaranteeSettings - 尝试为超过弹性池请求的 DTU 的数据库提供 DTU 最小值。
400 ElasticPoolDtuUnsupported - 用户尝试使用不支持的 DTU 容量创建或更新弹性池。
400 ElasticPoolStorageAboveLimitGB - 尝试将弹性池存储限制设置为低于支持的限制。
400 ElasticPoolsNotEnabled - 尚未在此区域中启用弹性池。
400 ElasticPoolNotEmpty - 请求删除不为空的弹性池。
400 ElasticPoolStorageBelowLimitGB - 尝试将弹性池存储限制设置为低于支持的限制。
400 ElasticPoolStorageNotAllowedGB - 尝试设置与允许值不匹配的弹性池存储限制（以 gb 为单位）。
400 ElasticPoolDatabaseLimit - 弹性池已达到数据库数限制。
400 ElasticPoolDecreaseStorageLimitBelowUsage - 尝试将弹性池的存储限制降低到其存储使用量以下。
400 InvalidInputValueDatabaseDtuMinLargerThanMax - 尝试将每个数据库的 DTU 最小值设置为高于每个数据库的 DTU 最大值。
400 ElasticPoolInconsistentVcoreGuaranteeSettings - 数据库数和每个数据库的 VCore 最小值不能超过弹性池请求的 VCore 数。
400 ElasticPoolStorageBelowLimitMB - 尝试将弹性池存储限制设置为低于支持的限制。
400 ElasticPoolStorageNotAllowedMB - 尝试设置与允许值不匹配的弹性池存储限制（以 mb 为单位）。
400 ElasticPoolCapacityStorageNotAllowedMB - 尝试设置与允许值不匹配的弹性池存储限制（以 mb 为单位）。
400 ElasticPoolStorageAboveLimitMB - 尝试将弹性池存储限制设置为低于支持的限制。
400 RegionDoesNotSupportVersion - 用户尝试在不支持该服务器版本的位置创建指定版本的服务器。
400 InvalidTier - 用户指定的层无效。
400 SourceDatabaseEditionCouldNotBeUpgraded - 源数据库的版本不能高于目标数据库。
400 TargetDatabaseEditionCouldNotBeDowngraded - 目标数据库的版本不能低于源数据库。
400 ElasticPoolUpdateHkNotAllowed - 弹性池无法将其服务层级从“高级”降低到“标准”或“基本”，因为其一个或多个数据库使用内存优化对象。
400 UpdateNotAllowedIfGeoDrOperationInProgress - 不允许该操作，因为服务器“”{1}上数据库“”{0}的复制或故障转移操作当前正在进行。
400 RegionDoesNotAllowProvisioning - 所选位置不接受新的 Windows Azure SQL数据库服务器。这可能会在以后更改。
400 ElasticPoolOverFileSpace - 弹性池中的文件空间不足。
400 ElasticPoolDbDtuMinBelowLimit - 每个数据库请求的 DTU 最小值对于所请求的弹性池服务层太低。
400 ElasticPoolDbVcoreMaxBelowLimit - 对于所请求的弹性池服务层而言，每个数据库 VCore 请求的最大值太低。
400 ElasticPoolDbVcoreMaxAboveLimit - 对于所请求的弹性池服务层而言，每个数据库 VCore 请求的最大值过高。
400 InvalidInputValueForDatabaseVcoreMax - 尝试为与允许值不匹配的资源池设置每个数据库的 VCore 最大值。
400 ElasticPoolDbVcoreMinBelowLimit - 对于所请求的弹性池服务层而言，每个数据库 VCore 的最小值太低。
400 InvalidInputValueForDatabaseVcoreMin - 尝试为与允许的值不匹配的资源池设置每个数据库的 VCore 最小值。
400 PartnerDBNotCompatibleForSGXEnclave - 仅当两个数据库都在 DC 系列硬件上运行时，才支持尝试为已启用 enclave 的数据库设置 GeoDR 链接或更新 SLO。
400 InvalidInputValueDatabaseVcoreMinLargerThanMax - 尝试将每个数据库的 VCore 最小值设置为高于每个数据库的 VCore 最大值。
400 InvalidLicenseType - 用户尝试使用不受支持的许可证类型创建或更新数据库或弹性池。
400 ProvisioningDisabled - 按原样显示来自资源操作授权者的错误消息，不需更改
400 InvalidPublicMaintenanceConfiguration - 用户尝试指定无法转换为内部 ID 的公共维护配置， (格式不正确或错误的区域) 。
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器
404 ServerNotInSubscriptionResourceGroup - 指定的服务器不存在于指定的资源组和订阅中。
404 ElasticPoolNotFound - 指定的服务器不存在指定的弹性池。
404 OperationIdNotFound - ID 为的操作不存在。
404 ResourceNotFound - 找不到请求的资源。
405 NotSupported - 不支持此功能。
409 ElasticPoolBusy - 在忙的弹性池上尝试了管理操作。
409 ServerDisabled - 服务器已禁用。
409 SimultaneousSkuChangeNotAllowed - 服务目标更改操作不能同时在复制关系的两个数据库上运行。
409 ElasticPoolUpdateLinksNotInCatchup - 当其中一个数据库正在执行复制或异地复制故障转移操作时，无法更新弹性池。
409 OperationCancelled - 用户已取消该操作。
409 操作中断 - 无法完成对资源的操作，因为它被同一资源上的另一个操作中断。
429 SubscriptionTooManyCreateUpdateRequests - 超出可用资源可处理的最大请求数的请求数。
429 SubscriptionTooManyRequests - 超出可用资源可处理的最大请求数的请求数。
500 ElasticPoolFailedMoveDbToElasticPool - 由于内部资源约束，无法将数据库移动到弹性池。这可能是暂时性的情况，请重试。
500 OperationTimedOut - 操作超时并自动回滚。请重试该操作。
503 ServiceTemporarilyUnavailable - 功能暂时不可用。
503 TooManyRequests - 超出可用资源可处理的最大请求数的请求数。

示例

Get a Hyperscale elastic pool

Get an elastic pool

Get a Hyperscale elastic pool

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102?api-version=2021-11-01


/**
 * Samples for ElasticPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/HyperscaleElasticPoolGet.json
     */
    /**
     * Sample code: Get a Hyperscale elastic pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAHyperscaleElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getElasticPools().getWithResponse("sqlcrudtest-2369",
            "sqlcrudtest-8069", "sqlcrudtest-8102", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "location": "Japan East",
  "kind": "vcore,pool",
  "sku": {
    "name": "HS_Gen5",
    "tier": "Hyperscale",
    "family": "Gen5",
    "capacity": 4
  },
  "properties": {
    "state": "Ready",
    "creationDate": "2021-08-26T03:46:20.57Z",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "minCapacity": 0,
      "maxCapacity": 4
    },
    "zoneRedundant": false,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "highAvailabilityReplicaCount": 2
  }
}

Get an elastic pool

示例请求

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102?api-version=2021-11-01


/**
 * Samples for ElasticPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ElasticPoolGet.json
     */
    /**
     * Sample code: Get an elastic pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getElasticPools().getWithResponse("sqlcrudtest-2369",
            "sqlcrudtest-8069", "sqlcrudtest-8102", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "location": "Japan East",
  "kind": null,
  "sku": {
    "name": "GP_Gen5_2",
    "tier": "GeneralPurpose",
    "capacity": 2
  },
  "properties": {
    "creationDate": "2017-10-10T01:25:25.033Z",
    "state": "Ready",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "minCapacity": 0.25,
      "maxCapacity": 1
    },
    "zoneRedundant": true,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1"
  }
}

定义

名称	说明
ElasticPool	弹性池。
ElasticPoolLicenseType	要应用于此弹性池的许可证类型。
ElasticPoolPerDatabaseSettings	弹性池的每个数据库设置。
ElasticPoolState	弹性池的状态。
Sku	ARM 资源 SKU。

ElasticPool

弹性池。

名称	类型	说明
id	string	资源 ID。
kind	string	弹性池的类型。这是用于Azure 门户体验的元数据。
location	string	资源位置。
name	string	资源名称。
properties.creationDate	string	弹性池的创建日期 (ISO8601 格式) 。
properties.highAvailabilityReplicaCount	integer	与用于提供高可用性的弹性池关联的辅助副本数。仅适用于超大规模弹性池。
properties.licenseType	ElasticPoolLicenseType	要应用于此弹性池的许可证类型。
properties.maintenanceConfigurationId	string	分配给弹性池的维护配置 ID。此配置定义将发生维护更新的时间段。
properties.maxSizeBytes	integer	数据库弹性池的存储限制（以字节为单位）。
properties.minCapacity	number	无服务器池不会收缩到以下的最小容量（如果未暂停）
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	弹性池的每个数据库设置。
properties.state	ElasticPoolState	弹性池的状态。
properties.zoneRedundant	boolean	此弹性池是否为区域冗余，这意味着此弹性池的副本将分布在多个可用性区域。
sku	Sku	弹性池 SKU。 SKU 列表可能因区域和支持产品/服务而异。若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 `Capabilities_ListByLocation` REST API 或以下命令： `az sql elastic-pool list-editions -l <location> -o table`
tags	object	资源标记。
type	string	资源类型。

ElasticPoolLicenseType

要应用于此弹性池的许可证类型。

名称	类型	说明
BasePrice	string
LicenseIncluded	string

ElasticPoolPerDatabaseSettings

弹性池的每个数据库设置。

名称	类型	说明
maxCapacity	number	任何一个数据库都可以使用的最大容量。
minCapacity	number	保证所有数据库的最低容量。

ElasticPoolState

弹性池的状态。

名称	类型	说明
Creating	string
Disabled	string
Ready	string

Sku

ARM 资源 SKU。

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

通过

Elastic Pools - Get

URI 参数

响应

示例

Get a Hyperscale elastic pool

示例请求

示例响应

Get an elastic pool

示例请求

示例响应

定义

ElasticPool

ElasticPoolLicenseType

ElasticPoolPerDatabaseSettings

ElasticPoolState

Sku

其他资源