Share via


SqlServerJobAgentResource.GetJobExecutionsByAgent Method

Definition

Overloads

GetJobExecutionsByAgent(SqlServerJobAgentResourceGetJobExecutionsByAgentOptions, CancellationToken)

Lists all executions in a job agent.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions
  • Operation Id: JobExecutions_ListByAgent
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlServerJobExecutionResource
GetJobExecutionsByAgent(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all executions in a job agent.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions
  • Operation Id: JobExecutions_ListByAgent

GetJobExecutionsByAgent(SqlServerJobAgentResourceGetJobExecutionsByAgentOptions, CancellationToken)

Source:
SqlServerJobAgentResource.cs
Source:
SqlServerJobAgentResource.cs

Lists all executions in a job agent.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions
  • Operation Id: JobExecutions_ListByAgent
  • Default Api Version: 2020-11-01-preview
  • Resource: SqlServerJobExecutionResource
public virtual Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource> GetJobExecutionsByAgent (Azure.ResourceManager.Sql.Models.SqlServerJobAgentResourceGetJobExecutionsByAgentOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetJobExecutionsByAgent : Azure.ResourceManager.Sql.Models.SqlServerJobAgentResourceGetJobExecutionsByAgentOptions * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
override this.GetJobExecutionsByAgent : Azure.ResourceManager.Sql.Models.SqlServerJobAgentResourceGetJobExecutionsByAgentOptions * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
Public Overridable Function GetJobExecutionsByAgent (options As SqlServerJobAgentResourceGetJobExecutionsByAgentOptions, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SqlServerJobExecutionResource)

Parameters

options
SqlServerJobAgentResourceGetJobExecutionsByAgentOptions

A property bag which contains all the parameters of this method except the LRO qualifier and request context parameter.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of SqlServerJobExecutionResource that may take multiple service requests to iterate over.

Applies to

GetJobExecutionsByAgent(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Source:
SqlServerJobAgentResource.cs
Source:
SqlServerJobAgentResource.cs

Lists all executions in a job agent.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions
  • Operation Id: JobExecutions_ListByAgent
public virtual Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource> GetJobExecutionsByAgent (DateTimeOffset? createTimeMin = default, DateTimeOffset? createTimeMax = default, DateTimeOffset? endTimeMin = default, DateTimeOffset? endTimeMax = default, bool? isActive = default, int? skip = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetJobExecutionsByAgent : Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
override this.GetJobExecutionsByAgent : Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
Public Overridable Function GetJobExecutionsByAgent (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 Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SqlServerJobExecutionResource)

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.

isActive
Nullable<Boolean>

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

skip
Nullable<Int32>

The number of elements in the collection to skip.

top
Nullable<Int32>

The number of elements to return from the collection.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

A collection of SqlServerJobExecutionResource that may take multiple service requests to iterate over.

Applies to