migrations

Creates, updates, deletes, gets or lists a migrations resource.

Overview

Name	migrations
Type	Resource
Id	sumologic.dashboards.migrations

Fields

The following fields are returned by SELECT queries:

get

Dashboard migration job status.

Name	Datatype	Description
error	object
status	string	Whether or not the request is in progress (InProgress), has completed successfully (Success), or has completed with an error (Failed).
status_message	string	Additional status message generated if the status is not Failed. (wire: statusMessage)

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 Dashboard Migration job for the given job identifier. If job succeeds, use Dashboard Migration Result endpoint to see results of the migration.
create	insert	region, content_ids		Schedule an asynchronous job to migrate a list of legacy Dashboards to Dashboard(New). Once migration is finished, the migrated dashboards will be in the same folder as the corresponding legacy Dashboard.<br />Note: This feature is in beta and may not support all existing features of legacy dashboards.<br />
preview	exec	region, contentIds		Get a preview of migrating Legacy Dashboards to Dashboard(New)

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	The identifier of the asynchronous Dashboard Migration job. (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 Dashboard Migration job for the given job identifier. If job succeeds, use Dashboard Migration Result endpoint to see results of the migration.

SELECT
error,
status,
status_message
FROM sumologic.dashboards.migrations
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

INSERT examples

create

Schedule an asynchronous job to migrate a list of legacy Dashboards to Dashboard(New). Once migration is finished, the migrated dashboards will be in the same folder as the corresponding legacy Dashboard.<br />Note: This feature is in beta and may not support all existing features of legacy dashboards.<br />

INSERT INTO sumologic.dashboards.migrations (
content_ids,
region
)
SELECT 
'{{ content_ids }}' /* required */,
'{{ region }}'
RETURNING
job_id
;

Manifest

# Description fields are for documentation purposes
- name: migrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the migrations resource.
  - name: content_ids
    value:
      - "{{ content_ids }}"
    description: |
      Content identifiers of the Legacy dashboards.

Lifecycle Methods

EXEC variables use wire (API) names.

preview

Get a preview of migrating Legacy Dashboards to Dashboard(New)

EXEC sumologic.dashboards.migrations.preview 
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set 
@@json=
'{
"contentIds": "{{ contentIds }}"
}'
;