SqlPoolWorkloadClassifierOperations Class

SqlPoolWorkloadClassifierOperations 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.

Constructor

SqlPoolWorkloadClassifierOperations(client, config, serializer, deserializer)

Parameters

Name Description
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

Name Description
models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

Create Or Update workload classifier.

Create Or Update workload classifier for a Sql pool's workload group.

begin_delete

Remove workload classifier.

Remove workload classifier of a Sql pool's workload group.

get

Get workload classifier.

Get a workload classifier of Sql pool's workload group.

list

Sql pool's workload classifier.

Get list of Sql pool's workload classifier for workload groups.

begin_create_or_update

Create Or Update workload classifier.

Create Or Update workload classifier for a Sql pool's workload group.

begin_create_or_update(resource_group_name: str, workspace_name: str, sql_pool_name: str, workload_group_name: str, workload_classifier_name: str, parameters: '_models.WorkloadClassifier', **kwargs: Any) -> LROPoller['_models.WorkloadClassifier']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.

workspace_name
Required
str

The name of the workspace.

sql_pool_name
Required
str

SQL pool name.

workload_group_name
Required
str

The name of the workload group.

workload_classifier_name
Required
str

The name of the workload classifier.

parameters
Required

The properties of the workload classifier.

Keyword-Only Parameters

Name Description
cls

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

Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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

Type Description

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

Exceptions

Type Description

begin_delete

Remove workload classifier.

Remove workload classifier of a Sql pool's workload group.

begin_delete(resource_group_name: str, workspace_name: str, sql_pool_name: str, workload_group_name: str, workload_classifier_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.

workspace_name
Required
str

The name of the workspace.

sql_pool_name
Required
str

SQL pool name.

workload_group_name
Required
str

The name of the workload group.

workload_classifier_name
Required
str

The name of the workload classifier.

Keyword-Only Parameters

Name Description
cls

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

Pass in True if you'd like the ARMPolling polling method, False for no polling, or 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

Type Description

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

Exceptions

Type Description

get

Get workload classifier.

Get a workload classifier of Sql pool's workload group.

get(resource_group_name: str, workspace_name: str, sql_pool_name: str, workload_group_name: str, workload_classifier_name: str, **kwargs: Any) -> _models.WorkloadClassifier

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.

workspace_name
Required
str

The name of the workspace.

sql_pool_name
Required
str

SQL pool name.

workload_group_name
Required
str

The name of the workload group.

workload_classifier_name
Required
str

The name of the workload classifier.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

WorkloadClassifier, or the result of cls(response)

Exceptions

Type Description

list

Sql pool's workload classifier.

Get list of Sql pool's workload classifier for workload groups.

list(resource_group_name: str, workspace_name: str, sql_pool_name: str, workload_group_name: str, **kwargs: Any) -> Iterable['_models.WorkloadClassifierListResult']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.

workspace_name
Required
str

The name of the workspace.

sql_pool_name
Required
str

SQL pool name.

workload_group_name
Required
str

The name of the workload group.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

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

Exceptions

Type Description

Attributes

models

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