Share via

JobTargetExecutionsOperations Class

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

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

get

Gets a target execution.
list_by_job_execution

Lists target executions for all steps of a job execution.
list_by_step

Lists the target executions of a job step execution.

get

Gets a target execution.

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

The name of the step.
target_id
Required
str

The target id.

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_job_execution

Lists target executions for all steps 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) -> AsyncIterable[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.
job_execution_id
Required
str

The id of the job execution.
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
AsyncItemPaged[JobExecutionListResult]

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

Exceptions

Type Description
HttpResponseError

list_by_step

Lists the target executions of a job step execution.

list_by_step(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, step_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) -> AsyncIterable[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.
job_execution_id
Required
str

The id of the job execution.
step_name
Required
str

The name of the step.
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
AsyncItemPaged[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:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv223\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>