WorkloadGroupsOperations Class

WorkloadGroupsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

WorkloadGroupsOperations

Constructor

WorkloadGroupsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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, **kwargs: Any) -> LROPoller[_models.WorkloadGroup]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

workload_group_name

str

Required

The name of the workload group.

parameters

WorkloadGroup

Required

The requested workload group state.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either WorkloadGroup or the result of cls(response)

Return type

LROPoller[WorkloadGroup]

Exceptions

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

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

workload_group_name

str

Required

The name of the workload group to delete.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

get

Gets a workload group.

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

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

workload_group_name

str

Required

The name of the workload group.

cls

callable

A custom type or function that will be passed the direct response

Returns

WorkloadGroup, or the result of cls(response)

Return type

WorkloadGroup

Exceptions

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) -> Iterable[_models.WorkloadGroupListResult]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WorkloadGroupListResult or the result of cls(response)

Return type

ItemPaged[WorkloadGroupListResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>