WorkloadGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:workload_groups> attribute.

Constructor

WorkloadGroupsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a workload group.
begin_delete	Deletes a workload group.
get	Gets a workload group.
list_by_database	Gets the list of workload groups.

begin_create_or_update

Creates or updates a workload group.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, parameters: _models.WorkloadGroup, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.WorkloadGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
workload_group_name Required	str The name of the workload group. Required.
parameters Required	WorkloadGroup or IO[bytes] The requested workload group state. Is either a WorkloadGroup type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[WorkloadGroup]	An instance of LROPoller that returns either WorkloadGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a workload group.

begin_delete(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
workload_group_name Required	str The name of the workload group to delete. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a workload group.

get(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, **kwargs: Any) -> WorkloadGroup

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
workload_group_name Required	str The name of the workload group. Required.

Returns

Type	Description
WorkloadGroup	WorkloadGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_database

Gets the list of workload groups.

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) -> ItemPaged[WorkloadGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.

Returns

Type	Description
ItemPaged[WorkloadGroup]	An iterator like instance of either WorkloadGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>