Skip to content

Commit cbbfe86

Browse files
authored
Merge pull request #107591 from uhabiba04/master
updating to meet the doc standards and resolving code block issues
2 parents c0bb449 + c9a6ce3 commit cbbfe86

File tree

3 files changed

+30
-22
lines changed

3 files changed

+30
-22
lines changed

articles/industry/agriculture/manage-users-in-azure-farmbeats.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ Azure FarmBeats includes user management for people who are part of your Azure A
1414

1515
## Prerequisites
1616

17-
- An Azure FarmBeats installation is required. For more information, see [Install Azure FarmBeats](install-azure-farmbeats.md).
17+
- Azure FarmBeats installation is required. For more information, see [Install Azure FarmBeats](install-azure-farmbeats.md).
1818
- The email IDs of the users you want to add or remove from your Azure FarmBeats instance.
1919

2020
## Manage Azure FarmBeats users
2121

2222
Azure FarmBeats uses Azure AD for authentication, access control, and roles. You can add users in the Azure AD tenant as users in Azure FarmBeats.
2323

2424
> [!NOTE]
25+
> If a user is not an Azure AD tenant user, , follow the instructions in the **Add Azure AD users** section to complete the setup.
26+
2527
> If a user you're trying to add as an Azure FarmBeats user isn't present in the Azure AD tenant, complete the setup by following the instructions in the "Add Azure AD users" section.
2628
2729
Azure FarmBeats supports two types of user roles:
@@ -59,7 +61,7 @@ To remove users from the Azure FarmBeats system:
5961
## Add Azure AD users
6062

6163
> [!NOTE]
62-
> Azure FarmBeats users need to exist in the Azure AD tenant before you can assign them to applications and roles. If a user that you want to add to Azure FarmBeats doesn't already exist in the Azure AD tenant, follow the instructions in this section. If the user exists in the Azure AD tenant, you can skip these instructions.
64+
> Azure FarmBeats users need to exist in the Azure AD tenant before you assign them to applications and roles. If a user doesn't exist in the Azure AD tenant, follow the instructions in this section. Skip the instructions, if a user already exists in the Azure AD tenant.
6365
6466
To add users to Azure AD, do the following:
6567

articles/industry/agriculture/sensor-partner-integration-in-azure-farmbeats.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.author: v-umha
1111

1212
This article provides information about the Azure FarmBeats **Translator** component, which enables sensor partner integration.
1313

14-
Using this component, partners can integrate with FarmBeats using FarmBeats Data hub APIs and send customer device data and telemetry to FarmBeats Data hub. Once the data is available in FarmBeats, it is visualized using the FarmBeats Accelerator and can be used for data fusion and for building machine learning/artificial intelligence models.
14+
Using this component, partners can integrate with FarmBeats using FarmBeats Datahub APIs and send customer device data and telemetry to FarmBeats Datahub. Once the data is available in FarmBeats, it is visualized using the FarmBeats Accelerator and can be used for data fusion and for building machine learning/artificial intelligence models.
1515

1616
## Before you start
1717

@@ -45,7 +45,7 @@ FarmBeats uses Microsoft Azure Active Directory authentication. Azure App Serv
4545

4646
For more information, see [Azure Active Directory](https://docs.microsoft.com/azure/app-service/overview-authentication-authorization).
4747

48-
FarmBeats Data hub uses bearer authentication, which needs the following credentials:
48+
FarmBeats Datahub uses bearer authentication, which needs the following credentials:
4949
- Client ID
5050
- Client secret
5151
- Tenant ID
@@ -80,14 +80,14 @@ access_token = token_response.get('accessToken') 
8080

8181
**HTTP request headers**
8282

83-
Here are the most common request headers that need to be specified when you make an API call to FarmBeats Data hub.
83+
Here are the most common request headers that need to be specified when you make an API call to FarmBeats Datahub.
8484

8585

8686
**Header** | **Description and example**
8787
--- | ---
88-
Content-Type | The request format (Content-Type: application/<format>). For FarmBeats Data hub APIs, the format is JSON. Content-Type: application/json
88+
Content-Type | The request format (Content-Type: application/<format>). For FarmBeats Datahub APIs, the format is JSON. Content-Type: application/json
8989
Authorization | Specifies the access token required to make an API call. Authorization: Bearer <Access-Token>
90-
Accept | The response format. For FarmBeats Data hub APIs, the format is JSON. Accept: application/json
90+
Accept | The response format. For FarmBeats Datahub APIs, the format is JSON. Accept: application/json
9191

9292
**API requests**
9393

@@ -114,7 +114,7 @@ JSON is a common language-independent data format that provides a simple text re
114114

115115
## Metadata specifications
116116

117-
FarmBeats Data hub has the following APIs that enable device partners to create and manage device or sensor metadata.
117+
FarmBeats Datahub has the following APIs that enable device partners to create and manage device or sensor metadata.
118118

119119
- /**DeviceModel**: DeviceModel corresponds to the metadata of the device, such as the manufacturer and the type of device, which is either gateway or node.
120120
- /**Device**: Device corresponds to a physical device present on the farm.
@@ -225,11 +225,11 @@ The canonical message format is as follows:
225225
"sensordata": [
226226
{
227227
"timestamp": "< timestamp in ISO 8601 format >",
228-
"<sensor measure name (as defined in the Sensor Model)>": <value>
228+
"<sensor measure name (as defined in the Sensor Model)>": "<value>"
229229
},
230230
{
231231
"timestamp": "<timestamp in ISO 8601 format>",
232-
"<sensor measure name (as defined in the Sensor Model)>": <value>
232+
"<sensor measure name (as defined in the Sensor Model)>": "<value>"
233233
}
234234
]
235235
}
@@ -299,7 +299,7 @@ After customers have purchased and deployed devices or sensors, they can access
299299
300300
## Unlink FarmBeats
301301

302-
Device partners can enable customers to unlink an existing FarmBeats integration. Unlinking FarmBeats shouldn't delete any device or sensor metadata that was created in FarmBeats Data hub. Unlinking does the following:
302+
Device partners can enable customers to unlink an existing FarmBeats integration. Unlinking FarmBeats shouldn't delete any device or sensor metadata that was created in FarmBeats Datahub. Unlinking does the following:
303303

304304
- Stops telemetry flow.
305305
- Deletes and erases the integration credentials on the device partner.

articles/industry/agriculture/troubleshoot-azure-farmbeats.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.author: v-umha
1111

1212
This article provides solutions to common Azure FarmBeats issues.
1313

14-
For additional help, contact us at [email protected]. Be sure to include the **deployer.log** file in your email.
14+
For additional help, contact us at [email protected]. Ensure to include the **deployer.log** file in your email.
1515

1616
To download the **deployer.log** file, do the following:
1717

@@ -46,7 +46,7 @@ To understand how to download logs, go to the ["Collect logs manually"](#collect
4646

4747
**Corrective action**:
4848

49-
1. Ensure you have done the partner registration correctly - you can check this by going to your datahub swagger, navigate to /Partner API, Do a Get and check if the partner is registered. If not, please follow the [steps here](get-sensor-data-from-sensor-partner.md#enable-device-integration-with-farmbeats) to add partner.
49+
1. Ensure you have done the partner registration correctly - you can check this by going to your datahub swagger, navigate to /Partner API, Do a Get and check if the partner is registered. If not, follow the [steps here](get-sensor-data-from-sensor-partner.md#enable-device-integration-with-farmbeats) to add partner.
5050
2. Ensure that you have used the correct Telemetry message format:
5151

5252
```json
@@ -60,11 +60,11 @@ To understand how to download logs, go to the ["Collect logs manually"](#collect
6060
"sensordata": [
6161
{
6262
"timestamp": "< timestamp in ISO 8601 format >",
63-
"<sensor measure name (as defined in the Sensor Model)>": <value>
63+
"<sensor measure name (as defined in the Sensor Model)>": "<value>"
6464
},
6565
{
6666
"timestamp": "<timestamp in ISO 8601 format>",
67-
"<sensor measure name (as defined in the Sensor Model)>": <value>
67+
"<sensor measure name (as defined in the Sensor Model)>": "<value>"
6868
}
6969
]
7070
}
@@ -114,14 +114,14 @@ While you're deleting a device, you might encounter one of the following common
114114
2. Delete the specific device.
115115

116116
> [!NOTE]
117-
> You can't delete a device if sensors are associated with it. For more information about how to delete associated sensors, see the "Delete sensor" section in [Get sensor data from sensor partners](get-sensor-data-from-sensor-partner.md).
117+
> You can't delete a device if sensors are associated with it. For more information about how to delete associated sensors, see the **Delete sensor** section in [Get sensor data from sensor partners](get-sensor-data-from-sensor-partner.md).
118118
119119

120120
## Issues with jobs
121121

122122
### FarmBeats internal error
123123

124-
**Message**: "FarmBeats internal error, see troubleshooting guide for more details."
124+
**Message**: "FarmBeats internal error, see troubleshooting guide for more details".
125125

126126
**Corrective action**:
127127
This issue might result from a temporary failure in the data pipeline. Create the job again. If the error persists, add the error message in a post on the FarmBeats forum, or contact [email protected].
@@ -134,13 +134,13 @@ This issue might result from a temporary failure in the data pipeline. Create th
134134

135135
**Message**: "No matching users found."
136136

137-
**Corrective action**: Check the email ID for which you're trying to add a role assignment. The email ID must be an exact match of the ID that's registered for that user in the Active Directory. If the error persists, add the error message in a post on the FarmBeats forum, or contact [email protected].
137+
**Corrective action**: Check the email ID for which you're trying to add a role assignment. The email ID must be an exact match of the ID, which is registered for that user in the Active Directory. If the error persists, add the error message in a post on the FarmBeats forum, or contact [email protected].
138138

139139
### Unable to log in to Accelerator
140140

141-
**Message**: "Error: You are not authorized to call the service. Contact the admin for authorization."
141+
**Message**: "Error: You are not authorized to call the service. Contact the administrator for authorization."
142142

143-
**Corrective action**: Ask the admin to authorize you to access the FarmBeats deployment. This can be done by doing a POST of the RoleAssignment APIs or through the Access Control in the **Settings** pane in Accelerator.
143+
**Corrective action**: Ask the administrator to authorize you to access the FarmBeats deployment. This can be done by doing a POST of the RoleAssignment APIs or through the Access Control in the **Settings** pane in Accelerator.
144144

145145
If you've already been granted access and are facing this error, try again by refreshing the page. If the error persists, add the error message in a post on the FarmBeats forum, or contact [email protected].
146146

@@ -159,6 +159,7 @@ If the error persists, add the error message in a post on the FarmBeats forum, o
159159
**Issue**: FarmBeats Accelerator isn't showing the latest version, even after you've upgraded FarmBeatsDeployment.
160160

161161
**Corrective action**: This error occurs because of service worker persistence in the browser. Do the following:
162+
162163
1. Close all browser tabs that have Accelerator open, and close the browser window.
163164
2. Start a new instance of the browser, and reload the Accelerator URI. This action loads the new version of Accelerator.
164165

@@ -171,6 +172,7 @@ If the error persists, add the error message in a post on the FarmBeats forum, o
171172
**Corrective action**:
172173

173174
Do one of the following:
175+
174176
- Rerun the installer for upgrading Datahub with the correct username and password.
175177
- Rerun the failed job, or run a satellite indices job for a date range of 5 to 7 days, and then check to see whether the job is successful.
176178

@@ -194,6 +196,7 @@ This issue can occur if any maintenance activities are being done on the Sentine
194196
1. If any job or pipeline fails because maintenance is being performed, resubmit the job after some time. 
195197

196198
For information about any planned or unplanned Sentinel maintenance activities, go to the [Copernicus Open Access Hub News](https://scihub.copernicus.eu/news/) site.  
199+
197200
2. Rerun the failed job, or run a satellite indices job for a date range of 5 to 7 days, and then check to see whether the job is successful.
198201

199202
### Sentinel: Maximum number of connections reached
@@ -204,6 +207,7 @@ This issue can occur if any maintenance activities are being done on the Sentine
204207

205208
**Corrective action**:
206209
Try either of the following:
210+
207211
* Create a new Sentinel account, and then rerun the installer to upgrade Datahub by using a new Sentinel username and password.
208212
* Rerun the failed job or run a satellite indices job for a date range of 5 to 7 days, and then check to see whether the job is successful.
209213

@@ -215,13 +219,15 @@ Try either of the following:
215219
1. If any job or pipeline fails because maintenance is being performed, resubmit the job after some time. 
216220

217221
For information about any planned or unplanned Sentinel maintenance activities, go to the [Copernicus Open Access Hub News](https://scihub.copernicus.eu/news/) site.  
222+
218223
2. Rerun the failed job, or run a satellite indices job for a date range of 5 to 7 days, and then check to see whether the job is successful.
219224

220225
## Collect logs manually
221226

222227
[Install and deploy Azure Storage Explorer]( https://docs.microsoft.com/azure/vs-azure-tools-storage-manage-with-storage-explorer?tabs=windows).
223228

224229
### Collect Azure Data Factory job logs in Datahub
230+
225231
1. Sign in to the [Azure portal](https://portal.azure.com).
226232
2. In the **Search** box, search for the FarmBeats Datahub resource group.
227233

@@ -297,11 +303,11 @@ Try either of the following:
297303

298304
### Azure Active Directory (Azure AD)-related issues
299305

300-
**Error message**: "Could not update required settings to Azure AD App d41axx40-xx21-4fbd-8xxf-97xxx9e2xxc0: Insufficient privileges to complete the operation. Ensure that above settings are configured properly for the Azure AD App."
306+
**Error message**: "Could not update required settings to Azure AD App d41axx40-xx21-4fbd-8xxf-97xxx9e2xxc0: Insufficient privileges to complete the operation. Ensure that the above settings are configured properly for the Azure AD App."
301307

302308
**Meaning**: The Azure AD app registration configuration wasn't completed properly.
303309

304-
**Corrective action**: Ask the IT admin (the person with tenant read access) to use our [script](https://github.com/Azure-Samples/active-directory-dotnet-webapp-openidconnect/tree/master/AppCreationScripts) for creating the Azure AD app registration. This script automatically takes care of the configuration steps as well.
310+
**Corrective action**: Ask the IT administrator (the person with tenant read access) to use our [script](https://github.com/Azure-Samples/active-directory-dotnet-webapp-openidconnect/tree/master/AppCreationScripts) for creating the Azure AD app registration. This script automatically takes care of the configuration steps as well.
305311

306312
**Error message**: "Could not create new Active Directory Application '\<application name\>' in this tenant: Another object with the same value for property identifier URIs already exists."
307313

0 commit comments

Comments
 (0)