Sql Pool Data Warehouse User Activities - Get

Get SQL pool user activities
Gets the user activities of a SQL pool which includes running and suspended queries

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

URI Parameters

Name In Required Type Description
dataWarehouseUserActivityName
path True

DataWarehouseUserActivityName

The activity name of the Sql pool.

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

DataWarehouseUserActivities

OK

Other Status Codes

*** Error Responses: ***

  • 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.

  • 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.

  • 404 ResourceNotFound - The specified resource was not found.

Examples

Get a SQL Analytics pool user activity

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/testdb/dataWarehouseUserActivities/current?api-version=2021-06-01

Sample Response

{
  "properties": {
    "activeQueriesCount": 0
  },
  "id": "subscriptions/326affc3-21f4-4471-a545-e37430b70113/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/dwdb01/dataWarehouseUserActivities/current",
  "name": "current",
  "type": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseUserActivities"
}

Definitions

Name Description
DataWarehouseUserActivities

User activities of a data warehouse

DataWarehouseUserActivityName

The activity name of the Sql pool.

DataWarehouseUserActivities

User activities of a data warehouse

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.activeQueriesCount

integer

Count of running and suspended queries.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DataWarehouseUserActivityName

The activity name of the Sql pool.

Name Type Description
current

string