jobs_job_histories
Creates, updates, deletes, gets or lists a jobs_job_histories resource.
Overview
| Name | jobs_job_histories |
| Type | Resource |
| Id | azure.scheduler.jobs_job_histories |
Fields
The following fields are returned by SELECT queries:
- list
The job histories have been successfully returned.
| Name | Datatype | Description |
|---|---|---|
id | string | Gets the job history identifier. |
name | string | Gets the job history name. |
properties | object | Gets or sets the job history properties. |
type | string | Gets the job history resource type. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | subscriptionId, resourceGroupName, jobCollectionName, jobName | api-version, $top, $skip, $filter | Lists job history. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
jobCollectionName | string | The job collection name. |
jobName | string | The job name. |
resourceGroupName | string | The resource group name. |
subscriptionId | string | The subscription id. |
$filter | string | The filter to apply on the job state. |
$skip | integer | The (0-based) index of the job history list from which to begin requesting entries. |
$top | integer | the number of job history to request, in the of range of [1..100]. |
api-version | string | The API version. |
SELECT examples
- list
Lists job history.
SELECT
id,
name,
properties,
type
FROM azure.scheduler.jobs_job_histories
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND jobCollectionName = '{{ jobCollectionName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $filter = '{{ $filter }}'
;