resource_jobs
Creates, updates, deletes, gets or lists a resource_jobs resource.
Overview
| Name | resource_jobs |
| Type | Resource |
| Id | azure.iot_hub.resource_jobs |
Fields
The following fields are returned by SELECT queries:
- get
- list
This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.
| Name | Datatype | Description |
|---|---|---|
endTimeUtc | string (date-time-rfc1123) | The time the job stopped processing. |
failureReason | string | If status == failed, this string containing the reason for the failure. |
jobId | string | The job identifier. |
parentJobId | string | The job identifier of the parent job, if any. |
startTimeUtc | string (date-time-rfc1123) | The start time of the job. |
status | string | The status of the job. |
statusMessage | string | The status message for the job. |
type | string | The type of the job. |
This is a synchronous operation. The response contains a JSON-serialized array of all the jobs in the IoT hub.
| Name | Datatype | Description |
|---|---|---|
endTimeUtc | string (date-time-rfc1123) | The time the job stopped processing. |
failureReason | string | If status == failed, this string containing the reason for the failure. |
jobId | string | The job identifier. |
parentJobId | string | The job identifier of the parent job, if any. |
startTimeUtc | string (date-time-rfc1123) | The start time of the job. |
status | string | The status of the job. |
statusMessage | string | The status message for the job. |
type | string | The type of the job. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, resourceName, jobId | api-version | Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
list | select | subscriptionId, resourceGroupName, resourceName | api-version | Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
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 |
|---|---|---|
jobId | string | The job identifier. |
resourceGroupName | string | The name of the resource group that contains the IoT hub. |
resourceName | string | The name of the IoT hub. |
subscriptionId | string | The subscription identifier. |
api-version | string | The version of the API. |
SELECT examples
- get
- list
Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
SELECT
endTimeUtc,
failureReason,
jobId,
parentJobId,
startTimeUtc,
status,
statusMessage,
type
FROM azure.iot_hub.resource_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND jobId = '{{ jobId }}' -- required
AND api-version = '{{ api-version }}'
;
Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
SELECT
endTimeUtc,
failureReason,
jobId,
parentJobId,
startTimeUtc,
status,
statusMessage,
type
FROM azure.iot_hub.resource_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND api-version = '{{ api-version }}'
;