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 參數

名稱	位於	必要	類型	Description
elasticPoolName	path	True	string	彈性集區的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	ElasticPool	成功
Other Status Codes		錯誤回應： ≦ 400 ElasticPoolOverStorageUsage - 當達到彈性集區的記憶體限制時，嘗試將數據寫入資料庫。 400 InvalidSku - 使用者指定了無效的 SKU。 400 InvalidTierSkuCombination - 指定的層不支援指定的 SKU。 400 ServerQuotaExceeded - 伺服器達到允許的資料庫輸送量單位限制。 400 ElasticPoolAlreadyExists - 伺服器已經包含具有指定名稱的彈性集區。 400 SubscriptionVcoreQuotaExceeded - 無法執行作業，因為訂用帳戶會超過允許的虛擬核心配額。 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 ElasticPoolUpdate HkNotAllowed - 彈性集區無法將其服務層級從進階降低為標準或基本，因為其中一或多個資料庫使用記憶體優化物件。 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 系列硬體上執行時，才支援設定已啟用記憶體保護區之資料庫的 GeoDR 連結或更新 SLO。 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - 嘗試將每個資料庫的 VCore 最小值設定為高於每個資料庫的 VCore 最大值。 400 InvalidLicenseType - 用戶嘗試使用不支援的授權類型來建立或更新資料庫或彈性集區。 400 ProvisioningDisabled - 依原樣顯示資源作業授權者的錯誤訊息，而不需變更 400 InvalidPublicMaintenanceConfiguration - 使用者嘗試指定公用維護設定，無法轉換成內部標識碼 (格式不正確或錯誤的區域) 。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。 404 ElasticPoolNotFound - 指定的彈性集區不存在於指定的伺服器。 404 OperationIdNotFound - 標識符為的作業不存在。 404 ResourceNotFound - 找不到所要求的資源。 405 NotSupported - 不支援此功能。 409 ElasticPoolBusy - 在忙碌的彈性集區上嘗試管理作業。 409 ServerDisabled - 伺服器已停用。 409 SimultaneousSkuChangeNotAllowed - 服務目標變更作業無法同時在復寫關聯性的兩個資料庫上執行。 409 ElasticPoolUpdateLinksNotInCatchup - 當其中一個資料庫執行複製或異地復寫故障轉移作業時，無法更新彈性集區。 409 OperationCancelled - 使用者已取消作業。 409 OperationInterrupted - 無法完成資源上的作業，因為它被相同資源上的另一個作業中斷。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理的最大要求。 500 ElasticPoolFailedMoveDbToElasticPool - 無法將資料庫移至彈性集區，因為內部資源限制。這可能是暫時性狀況，請重試。 500 OperationTimedOut - 作業逾時並自動回復。請重試該作業。 503 ServiceTemporarilyUnavailable - 功能暫時無法使用。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

名稱

類型

Description

200 OK

ElasticPool

成功

Other Status Codes

錯誤回應： ≦

400 ElasticPoolOverStorageUsage - 當達到彈性集區的記憶體限制時，嘗試將數據寫入資料庫。
400 InvalidSku - 使用者指定了無效的 SKU。
400 InvalidTierSkuCombination - 指定的層不支援指定的 SKU。
400 ServerQuotaExceeded - 伺服器達到允許的資料庫輸送量單位限制。
400 ElasticPoolAlreadyExists - 伺服器已經包含具有指定名稱的彈性集區。
400 SubscriptionVcoreQuotaExceeded - 無法執行作業，因為訂用帳戶會超過允許的虛擬核心配額。
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 ElasticPoolUpdate HkNotAllowed - 彈性集區無法將其服務層級從進階降低為標準或基本，因為其中一或多個資料庫使用記憶體優化物件。
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 系列硬體上執行時，才支援設定已啟用記憶體保護區之資料庫的 GeoDR 連結或更新 SLO。
400 InvalidInputValueDatabaseVcoreMinLargerThanMax - 嘗試將每個資料庫的 VCore 最小值設定為高於每個資料庫的 VCore 最大值。
400 InvalidLicenseType - 用戶嘗試使用不支援的授權類型來建立或更新資料庫或彈性集區。
400 ProvisioningDisabled - 依原樣顯示資源作業授權者的錯誤訊息，而不需變更
400 InvalidPublicMaintenanceConfiguration - 使用者嘗試指定公用維護設定，無法轉換成內部標識碼 (格式不正確或錯誤的區域) 。
404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器
404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。
404 ElasticPoolNotFound - 指定的彈性集區不存在於指定的伺服器。
404 OperationIdNotFound - 標識符為的作業不存在。
404 ResourceNotFound - 找不到所要求的資源。
405 NotSupported - 不支援此功能。
409 ElasticPoolBusy - 在忙碌的彈性集區上嘗試管理作業。
409 ServerDisabled - 伺服器已停用。
409 SimultaneousSkuChangeNotAllowed - 服務目標變更作業無法同時在復寫關聯性的兩個資料庫上執行。
409 ElasticPoolUpdateLinksNotInCatchup - 當其中一個資料庫執行複製或異地復寫故障轉移作業時，無法更新彈性集區。
409 OperationCancelled - 使用者已取消作業。
409 OperationInterrupted - 無法完成資源上的作業，因為它被相同資源上的另一個作業中斷。
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"
  }
}

定義

名稱	Description
ElasticPool	彈性集區。
ElasticPoolLicenseType	要套用至此彈性集區的授權類型。
ElasticPoolPerDatabaseSettings	彈性集區的每個資料庫設定。
ElasticPoolState	彈性集區的狀態。
Sku	ARM 資源 SKU。

ElasticPool

彈性集區。

名稱	類型	Description
id	string	資源識別碼。
kind	string	彈性集區種類。這是用於 Azure 入口網站體驗的元數據。
location	string	資源位置。
name	string	資源名稱。
properties.creationDate	string	彈性集區的建立日期 (ISO8601 格式) 。
properties.highAvailabilityReplicaCount	integer	與彈性集區相關聯的次要複本數目，可用來提供高可用性。僅適用於超大規模資料庫彈性集區。
properties.licenseType	ElasticPoolLicenseType	要套用至此彈性集區的授權類型。
properties.maintenanceConfigurationId	string	指派給彈性集區的維護設定標識符。此組態會定義將發生維護更新的期間。
properties.maxSizeBytes	integer	資料庫彈性集區的記憶體限制，以位元組為單位。
properties.minCapacity	number	無伺服器集區的最小容量不會縮小到下方，如果未暫停
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	彈性集區的每個資料庫設定。
properties.state	ElasticPoolState	彈性集區的狀態。
properties.zoneRedundant	boolean	不論此彈性集區是否為區域備援，這表示此彈性集區的複本會分散到多個可用性區域。
sku	Sku	彈性集區 SKU。 SKU 清單可能會因區域和支援供應項目而異。若要判斷 SKU (包括 SKU 名稱、層/版本、系列和容量) ，這些 SKU 可供您在 Azure 區域中的訂用帳戶使用，請使用 `Capabilities_ListByLocation` REST API 或下列命令： `az sql elastic-pool list-editions -l <location> -o table`
tags	object	資源標籤。
type	string	資源類型。

ElasticPoolLicenseType

要套用至此彈性集區的授權類型。

名稱	類型	Description
BasePrice	string
LicenseIncluded	string

ElasticPoolPerDatabaseSettings

彈性集區的每個資料庫設定。

名稱	類型	Description
maxCapacity	number	任何一個資料庫可以取用的最大容量。
minCapacity	number	保證所有資料庫的最小容量。

ElasticPoolState

彈性集區的狀態。

名稱	類型	Description
Creating	string
Disabled	string
Ready	string

Sku

ARM 資源 SKU。

名稱	類型	Description
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

其他資源