Package version:

Interface WorkloadGroups

Interface representing a WorkloadGroups.

Hierarchy

WorkloadGroups

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByDatabase

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, parameters: WorkloadGroup, options?: WorkloadGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkloadGroup>, WorkloadGroup>>
Creates or updates a workload group.
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.
- Optional options: WorkloadGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<WorkloadGroup>, WorkloadGroup>>
- Defined in operationsInterfaces/workloadGroups.ts:64

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, parameters: WorkloadGroup, options?: WorkloadGroupsCreateOrUpdateOptionalParams): Promise<WorkloadGroup>
Creates or updates a workload group.
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.
- Optional options: WorkloadGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<WorkloadGroup>
- Defined in operationsInterfaces/workloadGroups.ts:87

beginDelete

beginDelete(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, options?: WorkloadGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a workload group.
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.
- Optional options: WorkloadGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/workloadGroups.ts:104

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, options?: WorkloadGroupsDeleteOptionalParams): Promise<void>
Deletes a workload group.
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.
- Optional options: WorkloadGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/workloadGroups.ts:120

get

get(resourceGroupName: string, serverName: string, databaseName: string, workloadGroupName: string, options?: WorkloadGroupsGetOptionalParams): Promise<WorkloadGroup>
Gets a workload group
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.
- Optional options: WorkloadGroupsGetOptionalParams
  
  The options parameters.
Returns Promise<WorkloadGroup>
- Defined in operationsInterfaces/workloadGroups.ts:47

listByDatabase

listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: WorkloadGroupsListByDatabaseOptionalParams): PagedAsyncIterableIterator<WorkloadGroup>
Gets the list of workload groups
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.
- Optional options: WorkloadGroupsListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<WorkloadGroup>
- Defined in operationsInterfaces/workloadGroups.ts:32

Interface WorkloadGroups

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

workloadGroupName: string

parameters: WorkloadGroup

Optional options: WorkloadGroupsCreateOrUpdateOptionalParams

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

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

workloadGroupName: string

parameters: WorkloadGroup

Optional options: WorkloadGroupsCreateOrUpdateOptionalParams

Returns Promise<WorkloadGroup>

beginDelete

Parameters

resourceGroupName: string

serverName: string

databaseName: string

workloadGroupName: string

Optional options: WorkloadGroupsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

workloadGroupName: string

Optional options: WorkloadGroupsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

databaseName: string

workloadGroupName: string

Optional options: WorkloadGroupsGetOptionalParams

Returns Promise<WorkloadGroup>

listByDatabase

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: WorkloadGroupsListByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<WorkloadGroup>

Settings

Member Visibility

Theme

`Optional` options: WorkloadGroupsCreateOrUpdateOptionalParams

`Optional` options: WorkloadGroupsCreateOrUpdateOptionalParams

`Optional` options: WorkloadGroupsDeleteOptionalParams

`Optional` options: WorkloadGroupsDeleteOptionalParams

`Optional` options: WorkloadGroupsGetOptionalParams

`Optional` options: WorkloadGroupsListByDatabaseOptionalParams