Sql Pools - Pause
Pause SQL pool
Pause a SQL pool
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/pause?api-version=2021-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
sql
|
path | True |
string |
SQL pool name |
subscription
|
path | True |
string |
The ID of the target subscription. |
workspace
|
path | True |
string |
The name of the workspace. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Accepted |
|
Other Status Codes |
Examples
Pause a SQL Analytics pool
Sample request
Sample response
azure-asyncoperation: https://ms.web.azuresynapse.net
{
"tags": {
"tagKey1": "TagValue1"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/testdwdb",
"name": "testdwdb",
"type": "Microsoft.Synapse/workspaces/sqlPools",
"location": "Japan East",
"properties": {
"status": "Online",
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 268435456000,
"creationDate": "2017-02-10T00:56:19.2Z",
"provisioningState": "Succeeded",
"restorePointInTime": "0001-01-01T00:00:00Z"
},
"sku": {
"name": "DW100c"
}
}
azure-asyncoperation: https://ms.web.azuresynapse.net
{
"tags": {
"tagKey1": "TagValue1"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/testdwdb",
"name": "testdwdb",
"type": "Microsoft.Synapse/workspaces/sqlPools",
"location": "Japan East",
"properties": {
"status": "Online",
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 268435456000,
"creationDate": "2017-02-10T00:56:19.2Z",
"provisioningState": "Succeeded",
"restorePointInTime": "0001-01-01T00:00:00Z"
},
"sku": {
"name": "DW100c"
}
}
Definitions
Name | Description |
---|---|
create |
Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Sku |
Sku |
Sql |
SQL pool |
Storage |
The storage account type used to store backups for this sql pool. |
createMode
Specifies the mode of sql pool creation.
Default: regular sql pool creation.
PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.
Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.
Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.
Name | Type | Description |
---|---|---|
Default |
string |
|
PointInTimeRestore |
string |
|
Recovery |
string |
|
Restore |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
Sku
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. |
name |
string |
The SKU name |
tier |
string |
The service tier |
SqlPool
SQL pool
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
location |
string |
The geo-location where the resource lives |
|
name |
string |
The name of the resource |
|
properties.collation |
string |
Collation mode |
|
properties.createMode |
Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. |
||
properties.creationDate |
string |
Date the SQL pool was created |
|
properties.maxSizeBytes |
integer |
Maximum size in bytes |
|
properties.provisioningState |
string |
Resource state |
|
properties.recoverableDatabaseId |
string |
Backup database to restore from |
|
properties.restorePointInTime |
string |
Snapshot time to restore |
|
properties.sourceDatabaseDeletionDate |
string |
Specifies the time that the sql pool was deleted |
|
properties.sourceDatabaseId |
string |
Source database to create from |
|
properties.status |
string |
Resource status |
|
properties.storageAccountType | GRS |
The storage account type used to store backups for this sql pool. |
|
sku |
Sku |
||
tags |
object |
Resource tags. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
StorageAccountType
The storage account type used to store backups for this sql pool.
Name | Type | Description |
---|---|---|
GRS |
string |
|
LRS |
string |