Export - Jobs

Service:

Microsoft Cloud for Sustainability

API Version:

1.0

ExportJobs
Use Export APIs to transfer your emissions data directly to your Azure Data Lake Storage to do your own bulk processing.
The customer is advised that any ingress or egress related costs associated with this feature will be their responsibility. These costs may vary depending on the size and frequency of exports. Microsoft Cloud for Sustainability API Preview Terms and Conditions apply

GET https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}/export/jobs

With optional parameters:

GET https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}/export/jobs?skip={skip}

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string uuid	Format - uuid.
skip	query		integer int32	Format - int32.

Responses

Name	Type	Description
200 OK	ExportJob[]	The request has succeeded.
400 Bad Request	Error	An unexpected error response.
500 Internal Server Error	Error	An unexpected error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

subscription-key

Type: apiKey
In: query

Definitions

Name	Description
AzureOptions
DestinationOptions
Error
ExportJob

AzureOptions

Name	Type	Description
enrollmentIds	string[]
fileByteSizeLimit	integer
kustoOperationIds	string[]

DestinationOptions

Name	Type	Description
compression	boolean
compressionType	string
outputFormat	string

Error

Name	Type	Description
code	integer
message	string

ExportJob

Name	Type	Description
azureOptions	AzureOptions
createdUtc	string
datasourceId	string
destinationOptions	DestinationOptions
endTimeUtc	string
instanceId	string
jobId	string
kind	string
startTimeUtc	string
status	string
statusMessage	string
updatedUtc	string