Data Warehouse User Activities - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets the user activities of a data warehouse which includes running and suspended queries

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataWarehouseUserActivities/current?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
dataWarehouseUserActivityName	path	True	DataWarehouseUserActivityName	The activity name of the data warehouse.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	DataWarehouseUserActivities	Successfully get the data warehouse user activities.
Other Status Codes	ErrorResponse	* Error Responses: * 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition. 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 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.

Name

Type

Description

200 OK

DataWarehouseUserActivities

Successfully get the data warehouse user activities.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state
400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state
400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.
400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
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 the list of the user activities of a data warehouse

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/dataWarehouseUserActivities/current?api-version=2023-08-01

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetDataWarehouseUserActivities.json
// this example is just showing the usage of "DataWarehouseUserActivities_Get" 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 DataWarehouseUserActivityResource created on azure
// for more information of creating DataWarehouseUserActivityResource, please refer to the document of DataWarehouseUserActivityResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
DataWarehouseUserActivityName dataWarehouseUserActivityName = DataWarehouseUserActivityName.Current;
ResourceIdentifier dataWarehouseUserActivityResourceId = DataWarehouseUserActivityResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, dataWarehouseUserActivityName);
DataWarehouseUserActivityResource dataWarehouseUserActivity = client.GetDataWarehouseUserActivityResource(dataWarehouseUserActivityResourceId);

// invoke the operation
DataWarehouseUserActivityResource result = await dataWarehouseUserActivity.GetAsync();

// 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
DataWarehouseUserActivityData 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

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

Definitions

Name	Description
DataWarehouseUserActivities	User activities of a data warehouse
DataWarehouseUserActivityName	The activity name of the data warehouse.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

DataWarehouseUserActivities

Object

User activities of a data warehouse

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.activeQueriesCount	integer (int32)	Count of running and suspended queries.
type	string	Resource type.

DataWarehouseUserActivityName

Enumeration

The activity name of the data warehouse.

Value	Description
current

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.

Share via

Data Warehouse User Activities - Get

URI Parameters

Responses

Examples

Get the list of the user activities of a data warehouse

Sample request

Sample response

Definitions

DataWarehouseUserActivities

DataWarehouseUserActivityName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse