Sign in

v22

latestSwagger 2.02026-07-1372236814.0 KB
Job Schedules

Gets information about the specified Job Schedule.

get/jobschedules/{jobScheduleId}

Path parameters

jobScheduleIdstring required

The ID of the Job Schedule to get.

Query parameters

api-versionstring required

The API version to use for this operation.

timeOutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

$selectstring[]

An OData $select clause.

$expandstring[]

An OData $expand clause.

Headers

client-request-idstring

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc7231

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

If-Modified-Sincestring date-time-rfc7231

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

If-Unmodified-Sincestring date-time-rfc7231

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

If-Matchstring

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

If-None-Matchstring

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Response

The request has succeeded.

idstring required

A string that uniquely identifies the schedule within the Account.

displayNamestring

The display name for the schedule.

urlstring uri required

The URL of the Job Schedule.

eTagstring required

The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.

It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34".

lastModifiedstring date-time required

The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.

creationTimestring date-time required

The creation time of the Job Schedule.

state'active' | 'completed' | 'disabled' | 'terminating' | 'deleting' required

BatchJobScheduleState enums

stateTransitionTimestring date-time required

The time at which the Job Schedule entered the current state.

previousState'active' | 'completed' | 'disabled' | 'terminating' | 'deleting'

BatchJobScheduleState enums

previousStateTransitionTimestring date-time

The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state.