Share via


SqlServerJobAgentResource.GetJobExecutionsByAgentAsync Method

Definition

Overloads

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

GetJobExecutionsByAgentAsync(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.AsyncPageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource> GetJobExecutionsByAgentAsync (Azure.ResourceManager.Sql.Models.SqlServerJobAgentResourceGetJobExecutionsByAgentOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetJobExecutionsByAgentAsync : Azure.ResourceManager.Sql.Models.SqlServerJobAgentResourceGetJobExecutionsByAgentOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
override this.GetJobExecutionsByAgentAsync : Azure.ResourceManager.Sql.Models.SqlServerJobAgentResourceGetJobExecutionsByAgentOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
Public Overridable Function GetJobExecutionsByAgentAsync (options As SqlServerJobAgentResourceGetJobExecutionsByAgentOptions, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(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

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

Applies to

GetJobExecutionsByAgentAsync(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.AsyncPageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource> GetJobExecutionsByAgentAsync (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 GetJobExecutionsByAgentAsync : Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
override this.GetJobExecutionsByAgentAsync : Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sql.SqlServerJobExecutionResource>
Public Overridable Function GetJobExecutionsByAgentAsync (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 AsyncPageable(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

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

Applies to