JobAgentsOperations Class

JobAgentsOperations 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
JobAgentsOperations

Constructor

JobAgentsOperations(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 job agent.

begin_delete

Deletes a job agent.

begin_update

Updates a job agent.

get

Gets a job agent.

list_by_server

Gets a list of job agents in a server.

begin_create_or_update

Creates or updates a job agent.

begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: _models.JobAgent, **kwargs: Any) -> LROPoller[_models.JobAgent]

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.

job_agent_name
str
Required

The name of the job agent to be created or updated.

parameters
JobAgent
Required

The requested job agent resource 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 JobAgent or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes a job agent.

begin_delete(resource_group_name: str, server_name: str, job_agent_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.

job_agent_name
str
Required

The name of the job agent to be deleted.

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

Exceptions

begin_update

Updates a job agent.

begin_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: _models.JobAgentUpdate, **kwargs: Any) -> LROPoller[_models.JobAgent]

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.

job_agent_name
str
Required

The name of the job agent to be updated.

parameters
JobAgentUpdate
Required

The update to the job agent.

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 JobAgent or the result of cls(response)

Return type

Exceptions

get

Gets a job agent.

get(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> _models.JobAgent

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.

job_agent_name
str
Required

The name of the job agent to be retrieved.

cls
callable

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

Returns

JobAgent, or the result of cls(response)

Return type

Exceptions

list_by_server

Gets a list of job agents in a server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable[_models.JobAgentListResult]

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.

cls
callable

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

Returns

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

Return type

Exceptions

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'>