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.objectJobExecutionsOperations
Constructor
JobExecutionsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- 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
- resource_group_name
- 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.
- 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
An instance of LROPoller that returns either JobExecution or the result of cls(response)
Return type
Exceptions
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
- resource_group_name
- 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.
- 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
An instance of LROPoller that returns either JobExecution or the result of cls(response)
Return type
Exceptions
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) -> NoneParameters
- resource_group_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
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.JobExecutionParameters
- resource_group_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
JobExecution, or the result of cls(response)
Return type
Exceptions
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: 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
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- create_time_min
- datetime
If specified, only job executions created at or after the specified time are included.
- create_time_max
- datetime
If specified, only job executions created before the specified time are included.
- end_time_min
- datetime
If specified, only job executions completed at or after the specified time are included.
- end_time_max
- datetime
If specified, only job executions completed before the specified time are included.
- is_active
- bool
If specified, only active or only completed job executions are included.
- 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
Exceptions
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: 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
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- create_time_min
- datetime
If specified, only job executions created at or after the specified time are included.
- create_time_max
- datetime
If specified, only job executions created before the specified time are included.
- end_time_min
- datetime
If specified, only job executions completed at or after the specified time are included.
- end_time_max
- datetime
If specified, only job executions completed before the specified time are included.
- is_active
- bool
If specified, only active or only completed job executions are included.
- 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
Exceptions
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'>Feedback
Submit and view feedback for