JobExecutionsOperations Class

JobExecutionsOperations 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

JobExecutionsOperations

Constructor

JobExecutionsOperations(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	Starts an elastic job execution.
begin_create_or_update	Creates or updates a job execution.
cancel	Requests cancellation of a job execution.
get	Gets a job execution.
list_by_agent	Lists all executions in a job agent.
list_by_job	Lists a job's executions.

begin_create

Starts an elastic job execution.

begin_create(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) -> LROPoller['_models.JobExecution']

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

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

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Creates or updates a job execution.

begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) -> LROPoller['_models.JobExecution']

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.
job_execution_id Required	str The job execution id to create the job execution under.

Keyword-Only Parameters

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

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

Exceptions

Type	Description
HttpResponseError

cancel

Requests cancellation of a job execution.

cancel(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: 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.
job_execution_id Required	str The id of the job execution to cancel.

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

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

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.
job_execution_id Required	str The id of the job execution.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
JobExecution	JobExecution, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_agent

Lists all executions in a job agent.

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, create_time_min: datetime.datetime | None = None, create_time_max: datetime.datetime | None = None, end_time_min: datetime.datetime | None = None, end_time_max: datetime.datetime | None = None, is_active: bool | None = None, skip: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable['_models.JobExecutionListResult']

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.
create_time_min	datetime If specified, only job executions created at or after the specified time are included. Default value: None
create_time_max	datetime If specified, only job executions created before the specified time are included. Default value: None
end_time_min	datetime If specified, only job executions completed at or after the specified time are included. Default value: None
end_time_max	datetime If specified, only job executions completed before the specified time are included. Default value: None
is_active	bool If specified, only active or only completed job executions are included. Default value: None
skip	int The number of elements in the collection to skip. Default value: None
top	int The number of elements to return from the collection. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[JobExecutionListResult]	An iterator like instance of either JobExecutionListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_job

Lists a job's executions.

list_by_job(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, create_time_min: datetime.datetime | None = None, create_time_max: datetime.datetime | None = None, end_time_min: datetime.datetime | None = None, end_time_max: datetime.datetime | None = None, is_active: bool | None = None, skip: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable['_models.JobExecutionListResult']

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.
create_time_min	datetime If specified, only job executions created at or after the specified time are included. Default value: None
create_time_max	datetime If specified, only job executions created before the specified time are included. Default value: None
end_time_min	datetime If specified, only job executions completed at or after the specified time are included. Default value: None
end_time_max	datetime If specified, only job executions completed before the specified time are included. Default value: None
is_active	bool If specified, only active or only completed job executions are included. Default value: None
skip	int The number of elements in the collection to skip. Default value: None
top	int The number of elements to return from the collection. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[JobExecutionListResult]	An iterator like instance of either JobExecutionListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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