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
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
elastic
|
path | True |
string |
Имя эластичного пула. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Имя группы ресурсов. Имя регистронезависимо. |
|
server
|
path | True |
string |
Имени сервера. |
|
subscription
|
path | True |
string (uuid) |
Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID). |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| properties.autoPauseDelay |
integer (int32) |
Время в минутах после автоматической приостановки эластичного пула. Значение -1 означает, что автоматическая приостановка отключена |
| properties.availabilityZone |
Указывает зону доступности, на которую закреплена первичная реплика пула. |
|
| properties.highAvailabilityReplicaCount |
integer (int32) |
Количество вторичных реплик, связанных с эластичным пулом эластичного пула выпуска "Критически важный для бизнеса", "Премиум" или "Гипермасштабирование", используемых для обеспечения высокой доступности. Применимо только к эластичным пулам гипермасштабирования. |
| properties.licenseType |
Тип лицензии, применяемый для этого эластичного пула. |
|
| properties.maintenanceConfigurationId |
string |
Идентификатор конфигурации обслуживания, назначенный эластичному пулу. Эта конфигурация определяет период, когда будут выполняться обновления обслуживания. |
| properties.maxSizeBytes |
integer (int64) |
Ограничение хранилища для эластичного пула базы данных в байтах. |
| properties.minCapacity |
number (double) |
Минимальная емкость бессерверного пула не будет уменьшаться ниже, если не приостановлено |
| properties.perDatabaseSettings |
Параметры каждой базы данных для эластичного пула. |
|
| properties.preferredEnclaveType |
Тип анклава, запрошенного в эластичном пуле. |
|
| properties.zoneRedundant |
boolean |
Независимо от того, является ли этот эластичным пулом избыточным по зонам, то есть реплики этого эластичного пула будут распространяться по нескольким зонам доступности. |
| sku |
SKU ресурса ARM. |
|
| tags |
object |
Теги ресурсов. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Операция Azure успешно завершена. |
|
| 202 Accepted |
Принятый запрос на обновление ресурсов. Заголовки
|
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Azure Active Directory OAuth2 Flow.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
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
Образец запроса
Пример ответа
{
"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.
Образец запроса
Пример ответа
{
"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
Определения
| Имя | Описание |
|---|---|
|
Always |
Тип анклава, запрошенного в базе данных, например по умолчанию или анклавов VBS. |
|
Availability |
Указывает зону доступности, к ней закреплена база данных. |
|
created |
Тип удостоверения, создавшего ресурс. |
|
Elastic |
Эластичные пулы. |
|
Elastic |
Тип лицензии, применяемый для этого эластичного пула. |
|
Elastic |
Для каждого параметра базы данных эластичного пула. |
|
Elastic |
Состояние эластичного пула. |
|
Elastic |
Обновление эластичного пула. |
|
Error |
Ошибка управления ресурсами дополнительная информация. |
|
Error |
Детали ошибки. |
|
Error |
Ответ на ошибку |
| Sku |
SKU ресурса ARM. |
|
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
AlwaysEncryptedEnclaveType
Тип анклава, запрошенного в базе данных, например по умолчанию или анклавов VBS.
| Значение | Описание |
|---|---|
| Default |
По умолчанию |
| VBS |
VBS |
AvailabilityZoneType
Указывает зону доступности, к ней закреплена база данных.
| Значение | Описание |
|---|---|
| NoPreference |
Отсутствие предпочтений |
| 1 |
1 |
| 2 |
2 |
| 3 |
3 |
createdByType
Тип удостоверения, создавшего ресурс.
| Значение | Описание |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ElasticPool
Эластичные пулы.
| Имя | Тип | Описание |
|---|---|---|
| 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 |
Указывает зону доступности, на которую закреплена первичная реплика пула. |
|
| properties.creationDate |
string (date-time) |
Дата создания эластичного пула (формат ISO8601). |
| properties.highAvailabilityReplicaCount |
integer (int32) |
Количество вторичных реплик, связанных с эластичным пулом эластичного пула выпуска "Критически важный для бизнеса", "Премиум" или "Гипермасштабирование", используемых для обеспечения высокой доступности. Применимо только к эластичным пулам гипермасштабирования. |
| properties.licenseType |
Тип лицензии, применяемый для этого эластичного пула. |
|
| properties.maintenanceConfigurationId |
string |
Идентификатор конфигурации обслуживания, назначенный эластичному пулу. Эта конфигурация определяет период, когда будут выполняться обновления обслуживания. |
| properties.maxSizeBytes |
integer (int64) |
Ограничение хранилища для эластичного пула базы данных в байтах. |
| properties.minCapacity |
number (double) |
Минимальная емкость бессерверного пула не будет уменьшаться ниже, если не приостановлено |
| properties.perDatabaseSettings |
Параметры каждой базы данных для эластичного пула. |
|
| properties.preferredEnclaveType |
Тип анклава, запрошенного в эластичном пуле. |
|
| properties.state |
Состояние эластичного пула. |
|
| properties.zoneRedundant |
boolean |
Независимо от того, является ли этот эластичным пулом избыточным по зонам, то есть реплики этого эластичного пула будут распространяться по нескольким зонам доступности. |
| sku |
Номер SKU эластичного пула. Список номеров SKU может отличаться по регионам и предложению поддержки. Чтобы определить SKU (включая имя, уровень/издание, семейство и ёмкость), доступные вашей подписке в Azure регионе, используйте API REST
|
|
| systemData |
Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy. |
|
| tags |
object |
Теги ресурсов. |
| type |
string |
Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения» |
ElasticPoolLicenseType
Тип лицензии, применяемый для этого эластичного пула.
| Значение | Описание |
|---|---|
| LicenseIncluded |
ЛицензияВключено |
| BasePrice |
BasePrice |
ElasticPoolPerDatabaseSettings
Для каждого параметра базы данных эластичного пула.
| Имя | Тип | Описание |
|---|---|---|
| autoPauseDelay |
integer (int32) |
Автоматическая приостановка задержки для каждой базы данных в пуле |
| maxCapacity |
number (double) |
Максимальная емкость любой базы данных может использовать. |
| minCapacity |
number (double) |
Минимальная емкость всех баз данных гарантируется. |
ElasticPoolState
Состояние эластичного пула.
| Значение | Описание |
|---|---|
| Creating |
Создавать |
| Ready |
Ready |
| Disabled |
Disabled |
ElasticPoolUpdate
Обновление эластичного пула.
| Имя | Тип | Описание |
|---|---|---|
| properties.autoPauseDelay |
integer (int32) |
Время в минутах после автоматической приостановки эластичного пула. Значение -1 означает, что автоматическая приостановка отключена |
| properties.availabilityZone |
Указывает зону доступности, на которую закреплена первичная реплика пула. |
|
| properties.highAvailabilityReplicaCount |
integer (int32) |
Количество вторичных реплик, связанных с эластичным пулом эластичного пула выпуска "Критически важный для бизнеса", "Премиум" или "Гипермасштабирование", используемых для обеспечения высокой доступности. Применимо только к эластичным пулам гипермасштабирования. |
| properties.licenseType |
Тип лицензии, применяемый для этого эластичного пула. |
|
| properties.maintenanceConfigurationId |
string |
Идентификатор конфигурации обслуживания, назначенный эластичному пулу. Эта конфигурация определяет период, когда будут выполняться обновления обслуживания. |
| properties.maxSizeBytes |
integer (int64) |
Ограничение хранилища для эластичного пула базы данных в байтах. |
| properties.minCapacity |
number (double) |
Минимальная емкость бессерверного пула не будет уменьшаться ниже, если не приостановлено |
| properties.perDatabaseSettings |
Параметры каждой базы данных для эластичного пула. |
|
| properties.preferredEnclaveType |
Тип анклава, запрошенного в эластичном пуле. |
|
| properties.zoneRedundant |
boolean |
Независимо от того, является ли этот эластичным пулом избыточным по зонам, то есть реплики этого эластичного пула будут распространяться по нескольким зонам доступности. |
| sku |
SKU ресурса ARM. |
|
| tags |
object |
Теги ресурсов. |
ErrorAdditionalInfo
Ошибка управления ресурсами дополнительная информация.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительная информация. |
| type |
string |
Тип дополнительной информации. |
ErrorDetail
Детали ошибки.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Ошибка дополнительная информация. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
Sku
SKU ресурса ARM.
| Имя | Тип | Описание |
|---|---|---|
| capacity |
integer (int32) |
Емкость конкретного номера SKU. |
| family |
string |
Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь. |
| name |
string |
Имя номера SKU, как правило, буква + код номера, например P3. |
| size |
string |
Размер конкретного номера SKU |
| tier |
string |
Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум". |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
| Имя | Тип | Описание |
|---|---|---|
| createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
| createdBy |
string |
Удостоверение, создающее ресурс. |
| createdByType |
Тип удостоверения, создавшего ресурс. |
|
| lastModifiedAt |
string (date-time) |
Временная метка последнего изменения ресурса (UTC) |
| lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
| lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |