SqlServerJobAgentResource.GetByAgent Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Lists all executions in a job agent.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions.
- Operation Id. : JobAgents_ListByAgent.
- Default Api Version. : 2025-08-01-preview.
- Resource. : SqlServerJobAgentResource.
public virtual Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionData> GetByAgent(DateTimeOffset? createTimeMin = default, DateTimeOffset? createTimeMax = default, DateTimeOffset? endTimeMin = default, DateTimeOffset? endTimeMax = default, bool? isActive = default, long? skip = default, long? top = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetByAgent : Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Nullable<int64> * Nullable<int64> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionData>
override this.GetByAgent : Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Nullable<int64> * Nullable<int64> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionData>Public Overridable Function GetByAgent (Optional createTimeMin As Nullable(Of DateTimeOffset) = Nothing, Optional createTimeMax As Nullable(Of DateTimeOffset) = Nothing, Optional endTimeMin As Nullable(Of DateTimeOffset) = Nothing, Optional endTimeMax As Nullable(Of DateTimeOffset) = Nothing, Optional isActive As Nullable(Of Boolean) = Nothing, Optional skip As Nullable(Of Long) = Nothing, Optional top As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SqlServerJobExecutionData)Parameters
- createTimeMin
- Nullable<DateTimeOffset>
If specified, only job executions created at or after the specified time are included.
- createTimeMax
- Nullable<DateTimeOffset>
If specified, only job executions created before the specified time are included.
- endTimeMin
- Nullable<DateTimeOffset>
If specified, only job executions completed at or after the specified time are included.
- endTimeMax
- Nullable<DateTimeOffset>
If specified, only job executions completed before the specified time are included.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
A collection of SqlServerJobExecutionData that may take multiple service requests to iterate over.
