WorkloadGroups interface

Package:

@azure/arm-sql

Interface representing a WorkloadGroups.

Methods

beginCreateOrUpdate(string, string, string, string, WorkloadGroup, WorkloadGroupsCreateOrUpdateOptionalParams)	Creates or updates a workload group.
beginCreateOrUpdateAndWait(string, string, string, string, WorkloadGroup, WorkloadGroupsCreateOrUpdateOptionalParams)	Creates or updates a workload group.
beginDelete(string, string, string, string, WorkloadGroupsDeleteOptionalParams)	Deletes a workload group.
beginDeleteAndWait(string, string, string, string, WorkloadGroupsDeleteOptionalParams)	Deletes a workload group.
get(string, string, string, string, WorkloadGroupsGetOptionalParams)	Gets a workload group
listByDatabase(string, string, string, WorkloadGroupsListByDatabaseOptionalParams)	Gets the list of workload groups

Method Details

beginCreateOrUpdate(string, string, string, string, WorkloadGroup, WorkloadGroupsCreateOrUpdateOptionalParams)

Creates or updates a workload group.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, parameters: WorkloadGroup, options?: WorkloadGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkloadGroup>, WorkloadGroup>>

Parameters

resourceGroupName

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

string

The name of the server.

databaseName

string

The name of the database.

workloadGroupName

string

The name of the workload group.

parameters

WorkloadGroup

The requested workload group state.

options

WorkloadGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<WorkloadGroup>, WorkloadGroup>>

beginCreateOrUpdateAndWait(string, string, string, string, WorkloadGroup, WorkloadGroupsCreateOrUpdateOptionalParams)

Creates or updates a workload group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, parameters: WorkloadGroup, options?: WorkloadGroupsCreateOrUpdateOptionalParams): Promise<WorkloadGroup>

Parameters

resourceGroupName

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

string

The name of the server.

databaseName

string

The name of the database.

workloadGroupName

string

The name of the workload group.

parameters

WorkloadGroup

The requested workload group state.

options

WorkloadGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WorkloadGroup>

beginDelete(string, string, string, string, WorkloadGroupsDeleteOptionalParams)

Deletes a workload group.

function beginDelete(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, options?: WorkloadGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

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

string

The name of the server.

databaseName

string

The name of the database.

workloadGroupName

string

The name of the workload group to delete.

options

WorkloadGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, WorkloadGroupsDeleteOptionalParams)

Deletes a workload group.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, options?: WorkloadGroupsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

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

string

The name of the server.

databaseName

string

The name of the database.

workloadGroupName

string

The name of the workload group to delete.

options

WorkloadGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, WorkloadGroupsGetOptionalParams)

Gets a workload group

function get(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, options?: WorkloadGroupsGetOptionalParams): Promise<WorkloadGroup>

Parameters

resourceGroupName

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

string

The name of the server.

databaseName

string

The name of the database.

workloadGroupName

string

The name of the workload group.

options

WorkloadGroupsGetOptionalParams

The options parameters.

Returns

Promise<WorkloadGroup>

listByDatabase(string, string, string, WorkloadGroupsListByDatabaseOptionalParams)

Gets the list of workload groups

function listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: WorkloadGroupsListByDatabaseOptionalParams): PagedAsyncIterableIterator<WorkloadGroup, WorkloadGroup[], PageSettings>

Parameters

resourceGroupName

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

string

The name of the server.

databaseName

string

The name of the database.

options

WorkloadGroupsListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkloadGroup, WorkloadGroup[], PageSettings>