upgrade_jobs
Creates, updates, deletes, gets or lists a upgrade_jobs resource.
Overview​
| Name | upgrade_jobs |
| Type | Resource |
| Id | sumologic.apps.upgrade_jobs |
Fields​
The following fields are returned by SELECT queries:
- get
Status of the app upgrade job.
| Name | Datatype | Description |
|---|---|---|
folder_id | string | Identifier of the folder in which the app was upgraded. (example: 0000000001578BE8) (wire: folderId) |
instance_id | string | Instance identifier of the upgraded app. This field is not set yet but is a placeholder for future use. (example: 0000000001578BE8) (wire: instanceId) |
error | object | |
path | string | Path of the folder in which the app was upgraded. (example: /Library/Installed Apps/AWS CloudTrail) |
status | string | Whether or not the request is in progress (InProgress), has completed successfully (Success), or has completed with an error (Failed). (example: Success) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | job_id, region | Get the status of an asynchronous app upgrade request for the given job identifier. |
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 |
|---|---|---|
job_id | string | Identifier of the asynchronous job for upgrading the app. (example: C03E086C137F38B4) (wire: jobId) |
region | string | Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT) |
SELECT examples​
- get
Get the status of an asynchronous app upgrade request for the given job identifier.
SELECT
folder_id,
instance_id,
error,
path,
status
FROM sumologic.apps.upgrade_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;