JobAgentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:job_agents> attribute.

Constructor

JobAgentsOperations(*args, **kwargs)

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.

async begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: _models.JobAgent, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.JobAgent]

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.
job_agent_name Required	str The name of the job agent to be created or updated. Required.
parameters Required	JobAgent or IO[bytes] The requested job agent resource state. Is either a JobAgent type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a job agent.

async begin_delete(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> AsyncLROPoller[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.
job_agent_name Required	str The name of the job agent to be deleted. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a job agent.

async begin_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: _models.JobAgentUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.JobAgent]

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.
job_agent_name Required	str The name of the job agent to be updated. Required.
parameters Required	JobAgentUpdate or IO[bytes] The update to the job agent. Is either a JobAgentUpdate type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a job agent.

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

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.
job_agent_name Required	str The name of the job agent to be retrieved. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_server

Gets a list of job agents in a server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncItemPaged[JobAgent]

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.

Returns

Type	Description
AsyncItemPaged[JobAgent]	An iterator like instance of either JobAgent 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'>