Sql Pools - Update

Service:

Synapse

API Version:

2021-06-01

Update SQL pool
Apply a partial update to a SQL pool

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}?api-version=2021-06-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
sqlPoolName	path	True	string	SQL pool name
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
location	string	The geo-location where the resource lives
properties.collation	string	Collation mode
properties.createMode	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.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.storageAccountType	StorageAccountType	The storage account type used to store backups for this sql pool.
sku	Sku	Sku SQL pool SKU
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	SqlPool	OK
202 Accepted		Accepted
Other Status Codes	ErrorResponse

Examples

Update a SQL Analytics pool

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool?api-version=2021-06-01

{
  "location": "West US 2",
  "tags": {},
  "sku": {
    "tier": "",
    "name": ""
  },
  "properties": {
    "maxSizeBytes": 0,
    "collation": "",
    "restorePointInTime": "1970-01-01T00:00:00.000Z"
  }
}

Java

import com.azure.resourcemanager.synapse.models.Sku;
import com.azure.resourcemanager.synapse.models.SqlPool;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for SqlPools Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateSqlPool.json
     */
    /**
     * Sample code: Update a SQL Analytics pool.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void updateASQLAnalyticsPool(com.azure.resourcemanager.synapse.SynapseManager manager) {
        SqlPool resource = manager.sqlPools().getWithResponse("ExampleResourceGroup", "ExampleWorkspace",
            "ExampleSqlPool", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf()).withSku(new Sku().withTier("").withName("")).withMaxSizeBytes(0L).apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python update_sql_pool.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="01234567-89ab-4def-0123-456789abcdef",
    )

    response = client.sql_pools.begin_update(
        resource_group_name="ExampleResourceGroup",
        workspace_name="ExampleWorkspace",
        sql_pool_name="ExampleSqlPool",
        sql_pool_info={
            "location": "West US 2",
            "properties": {"collation": "", "maxSizeBytes": 0, "restorePointInTime": "1970-01-01T00:00:00.000Z"},
            "sku": {"name": "", "tier": ""},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateSqlPool.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsynapse_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateSqlPool.json
func ExampleSQLPoolsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolsClient().BeginUpdate(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", armsynapse.SQLPoolPatchInfo{
		Location: to.Ptr("West US 2"),
		Properties: &armsynapse.SQLPoolResourceProperties{
			Collation:          to.Ptr(""),
			MaxSizeBytes:       to.Ptr[int64](0),
			RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t }()),
		},
		SKU: &armsynapse.SKU{
			Name: to.Ptr(""),
			Tier: to.Ptr(""),
		},
		Tags: map[string]*string{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("ExampleSqlPool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/sqlPools/ExampleSqlPool"),
	// 	Location: to.Ptr("West US 2"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr(""),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](0),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		RecoverableDatabaseID: to.Ptr(""),
	// 		RestorePointInTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1970-01-01T00:00:00.000Z"); return t}()),
	// 		Status: to.Ptr("Paused"),
	// 		StorageAccountType: to.Ptr(armsynapse.StorageAccountTypeGRS),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 		Name: to.Ptr(""),
	// 		Tier: to.Ptr(""),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Apply a partial update to a SQL pool
 *
 * @summary Apply a partial update to a SQL pool
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateSqlPool.json
 */
async function updateASqlAnalyticsPool() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "01234567-89ab-4def-0123-456789abcdef";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "ExampleResourceGroup";
  const workspaceName = "ExampleWorkspace";
  const sqlPoolName = "ExampleSqlPool";
  const sqlPoolInfo = {
    collation: "",
    location: "West US 2",
    maxSizeBytes: 0,
    restorePointInTime: new Date("1970-01-01T00:00:00.000Z"),
    sku: { name: "", tier: "" },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.sqlPools.beginUpdateAndWait(
    resourceGroupName,
    workspaceName,
    sqlPoolName,
    sqlPoolInfo
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateSqlPool.json
// this example is just showing the usage of "SqlPools_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SynapseSqlPoolResource created on azure
// for more information of creating SynapseSqlPoolResource, please refer to the document of SynapseSqlPoolResource
string subscriptionId = "01234567-89ab-4def-0123-456789abcdef";
string resourceGroupName = "ExampleResourceGroup";
string workspaceName = "ExampleWorkspace";
string sqlPoolName = "ExampleSqlPool";
ResourceIdentifier synapseSqlPoolResourceId = SynapseSqlPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, sqlPoolName);
SynapseSqlPoolResource synapseSqlPool = client.GetSynapseSqlPoolResource(synapseSqlPoolResourceId);

// invoke the operation
SynapseSqlPoolPatch patch = new SynapseSqlPoolPatch()
{
    Tags =
    {
    },
    Location = new AzureLocation("West US 2"),
    Sku = new SynapseSku()
    {
        Tier = "",
        Name = "",
    },
    MaxSizeBytes = 0,
    Collation = "",
    RestorePointInTime = DateTimeOffset.Parse("1970-01-01T00:00:00.000Z"),
};
ArmOperation<SynapseSqlPoolResource> lro = await synapseSqlPool.UpdateAsync(WaitUntil.Completed, patch);
SynapseSqlPoolResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SynapseSqlPoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

azure-asyncoperation: https://ms.web.azuresynapse.net

{
  "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/sqlPools/ExampleSqlPool",
  "type": "Microsoft.Synapse/workspaces/sqlPools",
  "name": "ExampleSqlPool",
  "location": "West US 2",
  "tags": {},
  "sku": {
    "tier": "",
    "name": ""
  },
  "properties": {
    "maxSizeBytes": 0,
    "collation": "",
    "recoverableDatabaseId": "",
    "provisioningState": "Provisioning",
    "status": "Paused",
    "restorePointInTime": "1970-01-01T00:00:00.000Z",
    "creationDate": "1970-01-01T00:00:00.000Z",
    "storageAccountType": "GRS"
  }
}

Status code:

202

azure-asyncoperation: https://ms.web.azuresynapse.net

Definitions

Name	Description
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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Sku	Sku
SqlPool	SQL pool
SqlPoolPatchInfo	SQL pool patch info
StorageAccountType	The storage account type used to store backups for this sql pool.

createMode

Enumeration

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.

Value	Description
Default
PointInTimeRestore
Recovery
Restore

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Sku

Object

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

Object

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	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	StorageAccountType	GRS	The storage account type used to store backups for this sql pool.
sku	Sku		Sku SQL pool SKU
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SqlPoolPatchInfo

Object

SQL pool patch info

Name	Type	Default value	Description
location	string		The geo-location where the resource lives
properties.collation	string		Collation mode
properties.createMode	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	StorageAccountType	GRS	The storage account type used to store backups for this sql pool.
sku	Sku		Sku SQL pool SKU
tags	object		Resource tags.

StorageAccountType

Enumeration

The storage account type used to store backups for this sql pool.

Value	Description
GRS
LRS