JobStepExecutionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:job_step_executions> attribute.

Constructor

JobStepExecutionsOperations(*args, **kwargs)

Methods

get	Gets a step execution of a job execution.
list_by_job_execution	Lists the step executions of a job execution.

get

Gets a step execution of a job execution.

async get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, step_name: 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 to get. Required.
job_execution_id Required	str The unique id of the job execution. Required.
step_name Required	str The name of the step. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_job_execution

Lists the step executions of a job execution.

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