You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"batchVMSKU" : "<VM SKU. Default is standard_d2_v2>",
42
-
"dedicatedComputerNodes" : 1,
43
-
"nodeAgentSKUID": "<Node SKU. Default is batch.node.ubuntu 18.04>"
44
-
}
45
-
},
46
-
"partnerCredentials": {
47
-
"key1": "value1",
48
-
"key2": "value2"
49
-
},
50
-
"partnerType": "Weather",
51
-
"name": "<Name of the partner>",
52
-
"description": "<Description>",
53
-
"properties": {}
54
-
}
55
-
```
56
-
57
-
For example, to get weather data from NOAA by Azure Open Datasets, use the payload below. You can modify the name and description as per your preference.
58
-
59
-
```json
60
-
{
61
-
62
-
"dockerDetails": {
63
-
"imageName": "azurefarmbeats/farmbeats-noaa",
64
-
"imageTag": "latest",
65
-
"azureBatchVMDetails": {
66
-
"batchVMSKU": "standard_d2_v2",
67
-
"dedicatedComputerNodes": 1,
68
-
"nodeAgentSKUID": "batch.node.ubuntu 18.04"
69
-
}
70
-
},
71
-
"partnerType": "Weather",
72
-
"name": "ods-noaa",
73
-
"description": "NOAA data from Azure Open Datasets registered as a Weather Partner"
74
-
}
75
-
```
76
-
77
-
> [!NOTE]
78
-
> For more information about the Partner object, see [Appendix](get-weather-data-from-weather-partner.md#appendix)
79
-
80
-
The preceding step will provision the resources to enable docker to run in the customer's FarmBeats environment.
81
-
82
-
It takes about 10-15 minutes to provision the above resources.
30
+
```json
31
+
{
32
+
33
+
"dockerDetails": {
34
+
"credentials": {
35
+
"username": "<credentials to access private docker - not required for public docker>",
36
+
"password": "<credentials to access private docker – not required for public docker>"
37
+
},
38
+
"imageName" : "<docker image name. Default is azurefarmbeats/fambeats-noaa>",
"batchVMSKU" : "<VM SKU. Default is standard_d2_v2>",
42
+
"dedicatedComputerNodes" : 1,
43
+
"nodeAgentSKUID": "<Node SKU. Default is batch.node.ubuntu 18.04>"
44
+
}
45
+
},
46
+
"partnerCredentials": {
47
+
"key1": "value1",
48
+
"key2": "value2"
49
+
},
50
+
"partnerType": "Weather",
51
+
"name": "<Name of the partner>",
52
+
"description": "<Description>",
53
+
"properties": {}
54
+
}
55
+
```
56
+
57
+
For example, to get weather data from NOAA by Azure Open Datasets, use the payload below. You can modify the name and description as per your preference.
58
+
59
+
```json
60
+
{
61
+
62
+
"dockerDetails": {
63
+
"imageName": "azurefarmbeats/farmbeats-noaa",
64
+
"imageTag": "latest",
65
+
"azureBatchVMDetails": {
66
+
"batchVMSKU": "standard_d2_v2",
67
+
"dedicatedComputerNodes": 1,
68
+
"nodeAgentSKUID": "batch.node.ubuntu 18.04"
69
+
}
70
+
},
71
+
"partnerType": "Weather",
72
+
"name": "ods-noaa",
73
+
"description": "NOAA data from Azure Open Datasets registered as a Weather Partner"
74
+
}
75
+
```
76
+
77
+
> [!NOTE]
78
+
> For more information about the Partner object, see [Appendix](get-weather-data-from-weather-partner.md#appendix)
79
+
80
+
The preceding step will provision the resources to enable docker to run in the customer's FarmBeats environment.
81
+
82
+
It takes about 10-15 minutes to provision the above resources.
83
83
84
84
3. Check the status of the /Partner object that you created in step 2. To do this, make a GET request on /Partner API and check for the **status** of the partner object. Once FarmBeats provisions the partner successfully, the status is set to **Active**.
85
85
@@ -88,46 +88,46 @@ To start getting weather data on your FarmBeats Data hub, follow the steps below
88
88
89
89
5. Now your FarmBeats instance has an active weather data partner and you can run jobs to request weather data for a particular location (latitude/longitude) and a date range. The JobType(s) will have details on what parameters are required to run weather jobs.
90
90
91
-
For example, for NOAA data from Azure Open Datasets, following JobType(s) will be created:
91
+
For example, for NOAA data from Azure Open Datasets, following JobType(s) will be created:
6. Make a note of the **ID** and the parameters of the JobType(s).
97
97
98
98
7. Navigate to /Jobs API and make a POST request on /Jobs with the following input payload:
99
99
100
-
```json
100
+
```json
101
+
{
102
+
"typeId": "<id of the JobType>",
103
+
"arguments": {
104
+
"additionalProp1": {},
105
+
"additionalProp2": {},
106
+
"additionalProp3": {}
107
+
},
108
+
"name": "<name of the job>",
109
+
"description": "<description>",
110
+
"properties": {}
111
+
}
112
+
```
113
+
114
+
For example, to run **get_weather_data**, use the following payload:
115
+
116
+
```json
101
117
{
102
-
"typeId": "<id of the JobType>",
103
-
"arguments": {
104
-
"additionalProp1": {},
105
-
"additionalProp2": {},
106
-
"additionalProp3": {}
107
-
},
108
-
"name": "<name of the job>",
109
-
"description": "<description>",
110
-
"properties": {}
111
-
}
112
-
```
113
-
114
-
For example, to run **get_weather_data**, use the following payload:
115
-
116
-
```json
117
-
{
118
-
119
-
"typeId": "<id of the JobType>",
120
-
"arguments": {
121
-
"latitude": 47.620422,
122
-
"longitude": -122.349358,
123
-
"start_date": "yyyy-mm-dd",
124
-
"end_date": "yyyy-mm-dd"
125
-
},
126
-
"name": "<name of the job>",
127
-
"description": "<description>",
128
-
"properties": {}
129
-
}
130
-
```
118
+
119
+
"typeId": "<id of the JobType>",
120
+
"arguments": {
121
+
"latitude": 47.620422,
122
+
"longitude": -122.349358,
123
+
"start_date": "yyyy-mm-dd",
124
+
"end_date": "yyyy-mm-dd"
125
+
},
126
+
"name": "<name of the job>",
127
+
"description": "<description>",
128
+
"properties": {}
129
+
}
130
+
```
131
131
132
132
8. The preceding step will run the weather jobs as defined in the partner docker and ingest weather data into FarmBeats. You can check the status of the job by making a GET request on /Jobs and look for **currentState** in the response. Once complete, the currentState is set to **Succeeded**.
133
133
@@ -200,7 +200,7 @@ To query weather data using FarmBeats REST API, follow the steps below:
200
200
}
201
201
```
202
202
203
-
In the above example, the response has data for two timestamps along with the measure name ("Temperature") and values of the reported weather data in the two timestamps. You will need to refer to the associated Weather Data Model (as described in step 2 above) to interpret the type and unit of the reported values.
203
+
In the preceding example, the response has data for two timestamps along with the measure name ("Temperature") and values of the reported weather data in the two timestamps. You will need to refer to the associated Weather Data Model (as described in step 2 above) to interpret the type and unit of the reported values.
0 commit comments