weather

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

Overview

Name	weather
Type	Resource
Id	azure_extras.agrifood_farming.weather

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_raw	exec	partyId, boundaryId, extensionId, weatherDataType, granularity, endpoint	startDateTime, endDateTime, skipToken	Returns a paginated list of weather data.
get_data_delete_job_details	exec	job_id, endpoint		Get weather data delete job.
create_data_delete_job	exec	job_id, endpoint		Create a weather data delete job.
get_data_ingestion_job_details	exec	job_id, endpoint		Get weather ingestion job.
create_data_ingestion_job	exec	job_id, endpoint		Create a weather data ingestion job.

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
boundaryId	string	Boundary ID. Required.
endpoint	string	The service endpoint host (no scheme). (default: )
extensionId	string	ID of the weather extension. Required.
granularity	string	Granularity of weather data (daily/hourly). Required.
job_id	string	Job id supplied by user. Required.
partyId	string	Party ID. Required.
weatherDataType	string	Type of weather data (forecast/historical). Required.
endDateTime	string (date-time)	Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
skipToken	string	Skip token for getting next set of results. Default value is None.
startDateTime	string (date-time)	Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.

Lifecycle Methods

list_raw

Returns a paginated list of weather data.

EXEC azure_extras.agrifood_farming.weather.list_raw 
@partyId='{{ partyId }}' --required, 
@boundaryId='{{ boundaryId }}' --required, 
@extensionId='{{ extensionId }}' --required, 
@weatherDataType='{{ weatherDataType }}' --required, 
@granularity='{{ granularity }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@startDateTime='{{ startDateTime }}', 
@endDateTime='{{ endDateTime }}', 
@skipToken='{{ skipToken }}'
;

get_data_delete_job_details

Get weather data delete job.

EXEC azure_extras.agrifood_farming.weather.get_data_delete_job_details 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_data_delete_job

Create a weather data delete job.

EXEC azure_extras.agrifood_farming.weather.create_data_delete_job 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_data_ingestion_job_details

Get weather ingestion job.

EXEC azure_extras.agrifood_farming.weather.get_data_ingestion_job_details 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_data_ingestion_job

Create a weather data ingestion job.

EXEC azure_extras.agrifood_farming.weather.create_data_ingestion_job 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;