Sql Pool Operations - List

Service:

Synapse

API Version:

2021-06-01

Gets a list of operations performed on the SQL pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/operations?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.

Responses

Name	Type	Description
200 OK	SqlPoolBlobAuditingPolicySqlPoolOperationListResult	OK
Other Status Codes		*** Error Responses: *** 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects. 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server. 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached. 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server. 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters. 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage. 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported. 400 InvalidSku - The user specified an invalid sku. 400 InvalidTierSkuCombination - The specified tier does not support the specified sku. 400 ServerNotFound - The requested server was not found. 400 TokenTooLong - The provided token is too long. 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition. 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource. 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region. 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa. 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link. 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server. 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'. 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier. 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached. 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa. 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage. 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage. 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database. 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size. 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported. 400 InvalidTier - The user specified an invalid tier. 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation. 400 SubscriptionNotFound - The requested subscription was not found. 400 InvalidServerName - Invalid server name specified. 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed. 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress. 400 InvalidCollation - Collation is not recognized by the server. 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool. 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state. 400 GeoReplicaLimitReached - The per-replica replication limit was reached. 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name. 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers. 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues. 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server. 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database. 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account. 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database. 400 SourceDatabaseNotFound - The source database does not exist. 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity. 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account. 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation. 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 OperationIdNotFound - The operation with Id does not exist. 404 OperationIdNotFound - The operation with Id does not exist. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ServerNotInSubscription - Specified server does not exist on the specified subscription. 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ServerNotInSubscription - Specified server does not exist on the specified subscription. 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database. 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 SubscriptionDisabled - Subscription is disabled. 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed. 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed. 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota. 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship. 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption. 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress. 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done. 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time. 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship. 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship. 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request. 409 RemoteDatabaseExists - The destination database name already exists on the destination server. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

List the Sql Analytics pool management operations

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations?api-version=2021-06-01

Java

/** Samples for SqlPoolOperations List. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolOperations.json
     */
    /**
     * Sample code: List the Sql Analytics pool management operations.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void listTheSqlAnalyticsPoolManagementOperations(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sqlPoolOperations()
            .list("sqlcrudtest-7398", "sqlcrudtest-4645", "testdb", com.azure.core.util.Context.NONE);
    }
}

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 list_sql_pool_operations.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="00000000-1111-2222-3333-444444444444",
    )

    response = client.sql_pool_operations.list(
        resource_group_name="sqlcrudtest-7398",
        workspace_name="sqlcrudtest-4645",
        sql_pool_name="testdb",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolOperations.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"

	"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/ListSqlPoolOperations.json
func ExampleSQLPoolOperationsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewSQLPoolOperationsClient().NewListPager("sqlcrudtest-7398", "sqlcrudtest-4645", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolBlobAuditingPolicySQLPoolOperationListResult = armsynapse.SQLPoolBlobAuditingPolicySQLPoolOperationListResult{
		// 	Value: []*armsynapse.SQLPoolOperation{
		// 		{
		// 			Name: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/operations"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/11111111-1111-1111-1111-111111111111"),
		// 			Properties: &armsynapse.SQLPoolOperationProperties{
		// 				Description: to.Ptr("UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3"),
		// 				DatabaseName: to.Ptr("testdb"),
		// 				EstimatedCompletionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T13:10:10.000Z"); return t}()),
		// 				IsCancellable: to.Ptr(false),
		// 				Operation: to.Ptr("UpdateLogicalDatabase"),
		// 				OperationFriendlyName: to.Ptr("ALTER DATABASE"),
		// 				PercentComplete: to.Ptr[int32](100),
		// 				ServerName: to.Ptr("sqlcrudtest-4645"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T09:10:08.100Z"); return t}()),
		// 				State: to.Ptr(armsynapse.ManagementOperationStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("55555555-5555-5555-5555-555555555555"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/operations"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/55555555-5555-5555-5555-555555555555"),
		// 			Properties: &armsynapse.SQLPoolOperationProperties{
		// 				Description: to.Ptr("UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3"),
		// 				DatabaseName: to.Ptr("testdb"),
		// 				EstimatedCompletionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T13:10:10.000Z"); return t}()),
		// 				IsCancellable: to.Ptr(true),
		// 				Operation: to.Ptr("UpdateLogicalDatabase"),
		// 				OperationFriendlyName: to.Ptr("ALTER DATABASE"),
		// 				PercentComplete: to.Ptr[int32](19),
		// 				ServerName: to.Ptr("sqlcrudtest-4645"),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T10:10:08.100Z"); return t}()),
		// 				State: to.Ptr(armsynapse.ManagementOperationStateInProgress),
		// 			},
		// 	}},
		// }
	}
}

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 Gets a list of operations performed on the SQL pool.
 *
 * @summary Gets a list of operations performed on the SQL pool.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolOperations.json
 */
async function listTheSqlAnalyticsPoolManagementOperations() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "sqlcrudtest-7398";
  const workspaceName = "sqlcrudtest-4645";
  const sqlPoolName = "testdb";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sqlPoolOperations.list(
    resourceGroupName,
    workspaceName,
    sqlPoolName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/11111111-1111-1111-1111-111111111111",
      "name": "11111111-1111-1111-1111-111111111111",
      "type": "Microsoft.Synapse/workspaces/sqlPools/operations",
      "properties": {
        "databaseName": "testdb",
        "operation": "UpdateLogicalDatabase",
        "operationFriendlyName": "ALTER DATABASE",
        "percentComplete": 100,
        "serverName": "sqlcrudtest-4645",
        "startTime": "2017-06-01T09:10:08.10Z",
        "state": "Succeeded",
        "estimatedCompletionTime": "2017-06-01T13:10:10Z",
        "description": "UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3",
        "isCancellable": false
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/55555555-5555-5555-5555-555555555555",
      "name": "55555555-5555-5555-5555-555555555555",
      "type": "Microsoft.Synapse/workspaces/sqlPools/operations",
      "properties": {
        "databaseName": "testdb",
        "operation": "UpdateLogicalDatabase",
        "operationFriendlyName": "ALTER DATABASE",
        "percentComplete": 19,
        "serverName": "sqlcrudtest-4645",
        "startTime": "2017-06-01T10:10:08.10Z",
        "state": "InProgress",
        "estimatedCompletionTime": "2017-06-01T13:10:10Z",
        "description": "UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3",
        "isCancellable": true
      }
    }
  ]
}

Definitions

Name	Description
ManagementOperationState	The operation state.
SqlPoolBlobAuditingPolicySqlPoolOperationListResult	The response to a list Sql pool operations request
SqlPoolOperation	A Sql pool operation.

ManagementOperationState

The operation state.

Name	Type	Description
CancelInProgress	string
Cancelled	string
Failed	string
InProgress	string
Pending	string
Succeeded	string

SqlPoolBlobAuditingPolicySqlPoolOperationListResult

The response to a list Sql pool operations request

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	SqlPoolOperation[]	Array of results.

SqlPoolOperation

A Sql pool operation.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.databaseName	string	The name of the Sql pool the operation is being performed on.
properties.description	string	The operation description.
properties.errorCode	integer	The operation error code.
properties.errorDescription	string	The operation error description.
properties.errorSeverity	integer	The operation error severity.
properties.estimatedCompletionTime	string	The estimated completion time of the operation.
properties.isCancellable	boolean	Whether the operation can be cancelled.
properties.isUserError	boolean	Whether or not the error is a user error.
properties.operation	string	The name of operation.
properties.operationFriendlyName	string	The friendly name of operation.
properties.percentComplete	integer	The percentage of the operation completed.
properties.serverName	string	The name of the server.
properties.startTime	string	The operation start time.
properties.state	ManagementOperationState	The operation state.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"