Share via

JobsOperations Class

JobsOperations 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

JobsOperations(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

create_or_update

Creates or updates a job.
delete

Deletes a job.
get

Gets a job.
list_by_agent

Gets a list of jobs.

create_or_update

Creates or updates a job.

create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, parameters: '_models.Job', **kwargs: Any) -> _models.Job

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.
server_name
Required
str

The name of the server.
job_agent_name
Required
str

The name of the job agent.
job_name
Required
str

The name of the job to get.
parameters
Required
Job

The requested job state.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
Job

Job, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes a job.

delete(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) -> 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.
server_name
Required
str

The name of the server.
job_agent_name
Required
str

The name of the job agent.
job_name
Required
str

The name of the job to delete.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
None

None, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a job.

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

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.
server_name
Required
str

The name of the server.
job_agent_name
Required
str

The name of the job agent.
job_name
Required
str

The name of the job to get.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
Job

Job, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_agent

Gets a list of jobs.

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> Iterable['_models.JobListResult']

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.
server_name
Required
str

The name of the server.
job_agent_name
Required
str

The name of the job agent.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[JobListResult]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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