Elastic Pools - Update

Updates an elastic pool.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
path True
  • string

The name of the server.

elasticPoolName
path True
  • string

The name of the elastic pool.

api-version
query True
  • string

The API version to use for the request.

Request Body

Name Required Type Description
properties.licenseType

The license type to apply for this elastic pool.

properties.maxSizeBytes
  • integer

The storage limit for the database elastic pool in bytes.

properties.perDatabaseSettings

The per database settings for the elastic pool.

properties.zoneRedundant
  • boolean

Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

sku

The resource model definition representing SKU

tags
  • object

Resource tags.

Responses

Name Type Description
200 OK

Updated the elastic pool

202 Accepted

Accepted

Other Status Codes

*** Error Responses: ***

  • 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes

  • 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.

  • 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.

  • 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.

  • 400 InvalidTier - The user specified an invalid tier.

  • 400 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.

  • 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.

  • 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.

  • 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.

  • 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.

  • 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.

  • 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.

  • 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.

  • 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.

  • 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.

  • 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.

  • 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.

  • 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.

  • 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.

  • 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.

  • 400 ElasticPoolStorageDecreasePrecondition - There was an attempt to decrease the storage limit of the elastic pool below its storage usage.

  • 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.

  • 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.

  • 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.

  • 400 InvalidSkuName - Invalid SKU name.

  • 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.

  • 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.

  • 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.

  • 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes

  • 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.

  • 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.

  • 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.

  • 400 InvalidTier - The user specified an invalid tier.

  • 400 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.

  • 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.

  • 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.

  • 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.

  • 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.

  • 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.

  • 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.

  • 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.

  • 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.

  • 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.

  • 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.

  • 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.

  • 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.

  • 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.

  • 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.

  • 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.

  • 400 ElasticPoolStorageDecreasePrecondition - There was an attempt to decrease the storage limit of the elastic pool below its storage usage.

  • 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.

  • 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.

  • 405 NotSupported - This functionality is not supported.

  • 405 NotSupported - This functionality is not supported.

  • 409 ServerDisabled - Server is disabled.

  • 409 OperationCancelled - The operation has been cancelled by user.

  • 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.

  • 409 ServerDisabled - Server is disabled.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.

  • 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.

Examples

Update an elastic pool with all parameter
Update an elastic pool with mininum parameters

Update an elastic pool with all parameter

Sample Request

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=2017-10-01-preview
{
  "sku": {
    "name": "BC_Gen4_2",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "properties": {
    "perDatabaseSettings": {
      "minCapacity": 0.1,
      "maxCapacity": 1
    },
    "zoneRedundant": true,
    "licenseType": "LicenseIncluded"
  }
}

Sample Response

{
  "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": "BC_Gen4_2",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "properties": {
    "creationDate": "2017-02-10T01:27:21.32Z",
    "state": "Ready",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "minCapacity": 0.1,
      "maxCapacity": 1
    },
    "zoneRedundant": true,
    "licenseType": "LicenseIncluded"
  }
}

Update an elastic pool with mininum parameters

Sample Request

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=2017-10-01-preview
{}

Sample Response

{
  "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": "BasicPool",
    "tier": "Basic",
    "capacity": 50
  },
  "properties": {
    "creationDate": "2017-02-10T01:25:25.033Z",
    "state": "Ready",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "minCapacity": 0,
      "maxCapacity": 5
    }
  }
}

Definitions

ElasticPool

An elastic pool.

ElasticPoolLicenseType

The license type to apply for this elastic pool.

ElasticPoolPerDatabaseSettings

Per database settings of an elastic pool.

ElasticPoolState

The state of the elastic pool.

ElasticPoolUpdate

An elastic pool update.

Sku

The resource model definition representing SKU

ElasticPool

An elastic pool.

Name Type Description
id
  • string

Resource ID.

kind
  • string

Kind of elastic pool. This is metadata used for the Azure portal experience.

location
  • string

Resource location.

name
  • string

Resource name.

properties.creationDate
  • string

The creation date of the elastic pool (ISO8601 format).

properties.licenseType

The license type to apply for this elastic pool.

properties.maxSizeBytes
  • integer

The storage limit for the database elastic pool in bytes.

properties.perDatabaseSettings

The per database settings for the elastic pool.

properties.state

The state of the elastic pool.

properties.zoneRedundant
  • boolean

Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

sku

The resource model definition representing SKU

tags
  • object

Resource tags.

type
  • string

Resource type.

ElasticPoolLicenseType

The license type to apply for this elastic pool.

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

ElasticPoolPerDatabaseSettings

Per database settings of an elastic pool.

Name Type Description
maxCapacity
  • number

The maximum capacity any one database can consume.

minCapacity
  • number

The minimum capacity all databases are guaranteed.

ElasticPoolState

The state of the elastic pool.

Name Type Description
Creating
  • string
Disabled
  • string
Ready
  • string

ElasticPoolUpdate

An elastic pool update.

Name Type Description
properties.licenseType

The license type to apply for this elastic pool.

properties.maxSizeBytes
  • integer

The storage limit for the database elastic pool in bytes.

properties.perDatabaseSettings

The per database settings for the elastic pool.

properties.zoneRedundant
  • boolean

Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

sku

The resource model definition representing SKU

tags
  • object

Resource tags.

Sku

The resource model definition representing SKU

Name Type Description
capacity
  • integer

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

family
  • string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

name
  • string

The name of the SKU. Ex - P3. It is typically a letter+number code

size
  • string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier
  • string

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.