JobStepExecutionsOperations Class

JobStepExecutionsOperations 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

JobStepExecutionsOperations

Constructor

JobStepExecutionsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

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.

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

Parameters

resource_group_name

str

Required

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

str

Required

The name of the server.

job_agent_name

str

Required

The name of the job agent.

job_name

str

Required

The name of the job to get.

job_execution_id

str

Required

The unique id of the job execution.

step_name

str

Required

The name of the step.

cls

callable

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

Returns

JobExecution, or the result of cls(response)

Return type

JobExecution

Exceptions

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: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[_models.JobExecutionListResult]

Parameters

resource_group_name

str

Required

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

str

Required

The name of the server.

job_agent_name

str

Required

The name of the job agent.

job_name

str

Required

The name of the job to get.

job_execution_id

str

Required

The id of the job execution.

create_time_min

datetime

default value: None

If specified, only job executions created at or after the specified time are included.

create_time_max

datetime

default value: None

If specified, only job executions created before the specified time are included.

end_time_min

datetime

default value: None

If specified, only job executions completed at or after the specified time are included.

end_time_max

datetime

default value: None

If specified, only job executions completed before the specified time are included.

is_active

bool

default value: None

If specified, only active or only completed job executions are included.

skip

int

default value: None

The number of elements in the collection to skip.

top

int

default value: None

The number of elements to return from the collection.

cls

callable

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

Returns

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

Return type

ItemPaged[JobExecutionListResult]

Exceptions

HttpResponseError

Attributes

models

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