Elastic Pools - Update

更新彈性集區。

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

URI 參數

名稱 位於 必要 類型 Description
elasticPoolName
path True

string

彈性集區的名稱。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

資源群組的名稱。 名稱不區分大小寫。

serverName
path True

string

伺服器的名稱。

subscriptionId
path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

要求本文

名稱 類型 Description
properties.autoPauseDelay

integer (int32)

彈性集區自動暫停的分鐘數。 -1 值表示已停用自動暫停

properties.availabilityZone

AvailabilityZoneType

指定集區主要複本釘選到的可用性區域。

properties.highAvailabilityReplicaCount

integer (int32)

與商務關鍵、進階或超大規模資料庫版本彈性集區相關聯的次要複本數目,這些復本可用來提供高可用性。 僅適用於超大規模彈性集區。

properties.licenseType

ElasticPoolLicenseType

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

properties.maintenanceConfigurationId

string

指派給彈性集區的維護組態標識碼。 此組態會定義將發生維護更新的期間。

properties.maxSizeBytes

integer (int64)

資料庫彈性集區的記憶體限制,以位元組為單位。

properties.minCapacity

number (double)

如果未暫停,無伺服器集區的最小容量將不會縮小到下方

properties.perDatabaseSettings

ElasticPoolPerDatabaseSettings

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

properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

彈性集區上要求的記憶體保護區類型。

properties.zoneRedundant

boolean

此彈性集區是否為區域備援,這表示此彈性集區的複本會分散到多個可用性區域。

sku

Sku

ARM 資源 SKU。

tags

object

資源標籤。

回應

名稱 類型 Description
200 OK

ElasticPool

Azure 運作順利完成。

202 Accepted

已接受資源更新要求。

標題

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Assigns maintenance configuration to an elastic pool.
Resets maintenance configuration of an elastic pool to default.
Update an elastic pool with all parameter
Update an elastic pool with minimum parameters
Update an elastic pool with preferred enclave type parameter as Default
Update an elastic pool with preferred enclave type parameter as VBS
Update an elastic pool with serverless properties
Update high availability replica count of a Hyperscale elastic pool.

Assigns maintenance configuration to an elastic pool.

範例要求

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

{
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1"
  }
}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": null,
  "location": "Japan East",
  "properties": {
    "creationDate": "2017-02-10T01:25:25.033Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "maxCapacity": 5,
      "minCapacity": 0
    },
    "state": "Ready"
  },
  "sku": {
    "name": "BasicPool",
    "capacity": 50,
    "tier": "Basic"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2020-08-01

Resets maintenance configuration of an elastic pool to default.

範例要求

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

{
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
  }
}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": null,
  "location": "Japan East",
  "properties": {
    "creationDate": "2017-02-10T01:25:25.033Z",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "maxCapacity": 5,
      "minCapacity": 0
    },
    "state": "Ready"
  },
  "sku": {
    "name": "BasicPool",
    "capacity": 50,
    "tier": "Basic"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2020-08-01

Update an elastic pool with all parameter

範例要求

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

{
  "properties": {
    "licenseType": "LicenseIncluded",
    "perDatabaseSettings": {
      "maxCapacity": 1,
      "minCapacity": 0.25
    },
    "zoneRedundant": true
  },
  "sku": {
    "name": "BC_Gen4",
    "capacity": 2,
    "tier": "BusinessCritical"
  }
}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": null,
  "location": "Japan East",
  "properties": {
    "creationDate": "2017-02-10T01:27:21.32Z",
    "licenseType": "LicenseIncluded",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "maxCapacity": 1,
      "minCapacity": 0.25
    },
    "state": "Ready",
    "zoneRedundant": true
  },
  "sku": {
    "name": "BC_Gen4",
    "capacity": 2,
    "tier": "BusinessCritical"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2017-10-01

Update an elastic pool with minimum parameters

範例要求

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

{}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": null,
  "location": "Japan East",
  "properties": {
    "creationDate": "2017-02-10T01:25:25.033Z",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "maxCapacity": 5,
      "minCapacity": 0
    },
    "state": "Ready"
  },
  "sku": {
    "name": "BasicPool",
    "capacity": 50,
    "tier": "Basic"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2017-10-01

Update an elastic pool with preferred enclave type parameter as Default

範例要求

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

{
  "properties": {
    "preferredEnclaveType": "Default"
  },
  "sku": {
    "name": "GP_Gen5_4"
  }
}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": "vcore,pool",
  "location": "Japan East",
  "properties": {
    "creationDate": "2022-08-26T03:46:20.57Z",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "maxCapacity": 4,
      "minCapacity": 0
    },
    "preferredEnclaveType": "Default",
    "state": "Ready",
    "zoneRedundant": false
  },
  "sku": {
    "name": "GP_Gen5",
    "capacity": 4,
    "family": "Gen5",
    "tier": "GeneralPurpose"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2022-08-01

Update an elastic pool with preferred enclave type parameter as VBS

範例要求

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

{
  "properties": {
    "preferredEnclaveType": "VBS"
  },
  "sku": {
    "name": "GP_Gen5_4"
  }
}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": "vcore,pool",
  "location": "Japan East",
  "properties": {
    "creationDate": "2022-08-26T03:46:20.57Z",
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "maxCapacity": 4,
      "minCapacity": 0
    },
    "preferredEnclaveType": "VBS",
    "state": "Ready",
    "zoneRedundant": false
  },
  "sku": {
    "name": "GP_Gen5",
    "capacity": 4,
    "family": "Gen5",
    "tier": "GeneralPurpose"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2022-08-01

Update an elastic pool with serverless properties

範例要求

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

{
  "properties": {
    "autoPauseDelay": 60,
    "minCapacity": 0.5,
    "perDatabaseSettings": {
      "autoPauseDelay": 80,
      "maxCapacity": 2,
      "minCapacity": 0
    }
  },
  "sku": {
    "name": "GP_S_Gen5_2",
    "capacity": 2,
    "tier": "GeneralPurpose"
  }
}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": null,
  "location": "Japan East",
  "properties": {
    "autoPauseDelay": 60,
    "creationDate": "2017-02-10T01:25:25.033Z",
    "maxSizeBytes": 102400,
    "minCapacity": 0.5,
    "perDatabaseSettings": {
      "autoPauseDelay": 80,
      "maxCapacity": 2,
      "minCapacity": 0
    },
    "state": "Ready"
  },
  "sku": {
    "name": "GP_S_Gen5_2",
    "capacity": 2,
    "tier": "GeneralPurpose"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-05-01

Update high availability replica count of a Hyperscale elastic pool.

範例要求

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

{
  "properties": {
    "highAvailabilityReplicaCount": 2
  }
}

範例回覆

{
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "kind": "vcore,pool",
  "location": "Japan East",
  "properties": {
    "creationDate": "2021-08-26T03:46:20.57Z",
    "highAvailabilityReplicaCount": 2,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "maxCapacity": 4,
      "minCapacity": 0
    },
    "state": "Ready",
    "zoneRedundant": false
  },
  "sku": {
    "name": "HS_Gen5",
    "capacity": 4,
    "family": "Gen5",
    "tier": "Hyperscale"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/locations/japaneast1/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2021-08-01

定義

名稱 Description
AlwaysEncryptedEnclaveType

資料庫上要求的記憶體保護區類型,也就是預設或 VBS記憶體保護區。

AvailabilityZoneType

指定資料庫釘選到的可用性區域。

createdByType

建立資源的身分識別類型。

ElasticPool

彈性集區。

ElasticPoolLicenseType

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

ElasticPoolPerDatabaseSettings

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

ElasticPoolState

彈性集區的狀態。

ElasticPoolUpdate

彈性集區更新。

ErrorAdditionalInfo

資源管理錯誤附加資訊。

ErrorDetail

錯誤詳細資料。

ErrorResponse

錯誤回應

Sku

ARM 資源 SKU。

systemData

與建立和上次修改資源相關的元數據。

AlwaysEncryptedEnclaveType

資料庫上要求的記憶體保護區類型,也就是預設或 VBS記憶體保護區。

Description
Default

預設值

VBS

VBS

AvailabilityZoneType

指定資料庫釘選到的可用性區域。

Description
NoPreference

無偏好

1

1

2

2

3

3

createdByType

建立資源的身分識別類型。

Description
User
Application
ManagedIdentity
Key

ElasticPool

彈性集區。

名稱 類型 Description
id

string (arm-id)

資源的完整資源標識碼。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

kind

string

彈性集區種類。 這是用於 Azure 入口網站體驗的元資料。

location

string

資源所在的地理位置

name

string

資源的名稱

properties.autoPauseDelay

integer (int32)

彈性集區自動暫停的分鐘數。 -1 值表示已停用自動暫停

properties.availabilityZone

AvailabilityZoneType

指定集區主要複本釘選到的可用性區域。

properties.creationDate

string (date-time)

彈性集區的建立日期(ISO8601格式)。

properties.highAvailabilityReplicaCount

integer (int32)

與商務關鍵、進階或超大規模資料庫版本彈性集區相關聯的次要複本數目,這些復本可用來提供高可用性。 僅適用於超大規模彈性集區。

properties.licenseType

ElasticPoolLicenseType

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

properties.maintenanceConfigurationId

string

指派給彈性集區的維護組態標識碼。 此組態會定義將發生維護更新的期間。

properties.maxSizeBytes

integer (int64)

資料庫彈性集區的記憶體限制,以位元組為單位。

properties.minCapacity

number (double)

如果未暫停,無伺服器集區的最小容量將不會縮小到下方

properties.perDatabaseSettings

ElasticPoolPerDatabaseSettings

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

properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

彈性集區上要求的記憶體保護區類型。

properties.state

ElasticPoolState

彈性集區的狀態。

properties.zoneRedundant

boolean

此彈性集區是否為區域備援,這表示此彈性集區的複本會分散到多個可用性區域。

sku

Sku

彈性集區 SKU。

SKU 清單可能會因區域和支援供應項目而異。 要確定在Azure區域內訂閱可用的 SKU(包括 SKU 名稱、層級/版本、家族及容量),請使用 Capabilities_ListByLocation REST API 或以下指令:

az sql elastic-pool list-editions -l <location> -o table
systemData

systemData

Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。

tags

object

資源標籤。

type

string

資源的類型。 例如:「Microsoft。運算/虛擬機器」或「Microsoft」。儲存/儲存帳號」

ElasticPoolLicenseType

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

Description
LicenseIncluded

授權包含

BasePrice

BasePrice

ElasticPoolPerDatabaseSettings

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

名稱 類型 Description
autoPauseDelay

integer (int32)

集區內每個資料庫的自動暫停延遲

maxCapacity

number (double)

任何一個資料庫都可以取用的最大容量。

minCapacity

number (double)

保證所有資料庫的最小容量。

ElasticPoolState

彈性集區的狀態。

Description
Creating

建立中

Ready

Ready

Disabled

Disabled

ElasticPoolUpdate

彈性集區更新。

名稱 類型 Description
properties.autoPauseDelay

integer (int32)

彈性集區自動暫停的分鐘數。 -1 值表示已停用自動暫停

properties.availabilityZone

AvailabilityZoneType

指定集區主要複本釘選到的可用性區域。

properties.highAvailabilityReplicaCount

integer (int32)

與商務關鍵、進階或超大規模資料庫版本彈性集區相關聯的次要複本數目,這些復本可用來提供高可用性。 僅適用於超大規模彈性集區。

properties.licenseType

ElasticPoolLicenseType

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

properties.maintenanceConfigurationId

string

指派給彈性集區的維護組態標識碼。 此組態會定義將發生維護更新的期間。

properties.maxSizeBytes

integer (int64)

資料庫彈性集區的記憶體限制,以位元組為單位。

properties.minCapacity

number (double)

如果未暫停,無伺服器集區的最小容量將不會縮小到下方

properties.perDatabaseSettings

ElasticPoolPerDatabaseSettings

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

properties.preferredEnclaveType

AlwaysEncryptedEnclaveType

彈性集區上要求的記憶體保護區類型。

properties.zoneRedundant

boolean

此彈性集區是否為區域備援,這表示此彈性集區的複本會分散到多個可用性區域。

sku

Sku

ARM 資源 SKU。

tags

object

資源標籤。

ErrorAdditionalInfo

資源管理錯誤附加資訊。

名稱 類型 Description
info

object

附加資訊。

type

string

其他資訊類型。

ErrorDetail

錯誤詳細資料。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤附加資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳情

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

Sku

ARM 資源 SKU。

名稱 類型 Description
capacity

integer (int32)

特定 SKU 的容量。

family

string

如果服務有不同世代的硬體,針對相同的 SKU,則可以在這裡擷取。

name

string

SKU 的名稱,通常是字母 + 數位碼,例如 P3。

size

string

特定 SKU 的大小

tier

string

特定 SKU 的階層或版本,例如基本、進階。

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string (date-time)

資源建立的時間戳(UTC)。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string (date-time)

資源上次修改的時間戳記 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。