Condividi tramite

JobExecutionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:job_executions> attribute.

Constructor

JobExecutionsOperations(*args, **kwargs)

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.

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

The name of the server. Required.
job_agent_name
Required
str

The name of the job agent. Required.
job_name
Required
str

The name of the job to get. Required.

Returns

Type Description
AsyncLROPoller[JobExecution]

An instance of AsyncLROPoller that returns either JobExecution or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update

Creates or updates a job execution.

async begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) -> AsyncLROPoller[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. Required.
server_name
Required
str

The name of the server. Required.
job_agent_name
Required
str

The name of the job agent. Required.
job_name
Required
str

The name of the job to get. Required.
job_execution_id
Required
str

The job execution id to create the job execution under. Required.

Returns

Type Description
AsyncLROPoller[JobExecution]

An instance of AsyncLROPoller that returns either JobExecution or the result of cls(response)

Exceptions

Type Description
HttpResponseError

cancel

Requests cancellation of a job execution.

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

The name of the server. Required.
job_agent_name
Required
str

The name of the job agent. Required.
job_name
Required
str

The name of the job. Required.
job_execution_id
Required
str

The id of the job execution to cancel. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a job execution.

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

The name of the server. Required.
job_agent_name
Required
str

The name of the job agent. Required.
job_name
Required
str

The name of the job. Required.
job_execution_id
Required
str

The id of the job execution. Required.

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 | None = None, create_time_max: datetime | None = None, end_time_min: datetime | None = None, end_time_max: datetime | None = None, is_active: bool | None = None, skip: int | None = None, top: int | None = None, **kwargs: Any) -> AsyncItemPaged[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. Required.
server_name
Required
str

The name of the server. Required.
job_agent_name
Required
str

The name of the job agent. Required.
create_time_min
datetime

If specified, only job executions created at or after the specified time are included. Default value is None.

Default value: None
create_time_max
datetime

If specified, only job executions created before the specified time are included. Default value is None.

Default value: None
end_time_min
datetime

If specified, only job executions completed at or after the specified time are included. Default value is None.

Default value: None
end_time_max
datetime

If specified, only job executions completed before the specified time are included. Default value is None.

Default value: None
is_active
bool

If specified, only active or only completed job executions are included. Default value is None.

Default value: None
skip
int

The number of elements in the collection to skip. Default value is None.

Default value: None
top
int

The number of elements to return from the collection. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[JobExecution]

An iterator like instance of either JobExecution 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 | None = None, create_time_max: datetime | None = None, end_time_min: datetime | None = None, end_time_max: datetime | None = None, is_active: bool | None = None, skip: int | None = None, top: int | None = None, **kwargs: Any) -> AsyncItemPaged[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. Required.
server_name
Required
str

The name of the server. Required.
job_agent_name
Required
str

The name of the job agent. Required.
job_name
Required
str

The name of the job to get. Required.
create_time_min
datetime

If specified, only job executions created at or after the specified time are included. Default value is None.

Default value: None
create_time_max
datetime

If specified, only job executions created before the specified time are included. Default value is None.

Default value: None
end_time_min
datetime

If specified, only job executions completed at or after the specified time are included. Default value is None.

Default value: None
end_time_max
datetime

If specified, only job executions completed before the specified time are included. Default value is None.

Default value: None
is_active
bool

If specified, only active or only completed job executions are included. Default value is None.

Default value: None
skip
int

The number of elements in the collection to skip. Default value is None.

Default value: None
top
int

The number of elements to return from the collection. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[JobExecution]

An iterator like instance of either JobExecution 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'>