Skip to content

Commit 02f267c

Browse files
committed
added Microsoft APIs Terms of Use
1 parent 1ab68a6 commit 02f267c

File tree

3 files changed

+24
-20
lines changed

3 files changed

+24
-20
lines changed

articles/defender-for-iot/device-builders/azure-rtos-security-module-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ ms.author: mlottner
99

1010
# Defender-IoT-micro-agent for Azure RTOS API (preview)
1111

12-
This API is intended for use with the Defender-IoT-micro-agent for Azure RTOS only. For additional resources, see the [Defender-IoT-micro-agent for Azure RTOS GitHub resource](https://github.com/azure-rtos/azure-iot-preview/releases).
12+
Defender for IoT APIs are governed by [Microsoft API License and Terms of use](/legal/microsoft-apis/terms-of-use).
13+
14+
This API is intended for use with the Defender-IoT-micro-agent for Azure RTOS only. For additional resources, see the [Defender-IoT-micro-agent for Azure RTOS GitHub resource](https://github.com/azure-rtos/azure-iot-preview/releases).
1315

1416
## Enable Defender-IoT-micro-agent for Azure RTOS
1517

@@ -47,7 +49,6 @@ Threads
4749
4850
**nx_azure_iot_security_module_disable**
4951
50-
5152
### Prototype
5253
5354
```c
@@ -76,7 +77,6 @@ This routine disables the Azure IoT Defender-IoT-micro-agent subsystem.
7677

7778
Threads
7879

79-
8080
## Next steps
8181

8282
To learn more about how to get started with Azure RTOS Defender-IoT-micro-agent, see the following articles:

articles/defender-for-iot/organizations/references-horizon-api.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,22 @@ ms.date: 1/5/2021
55
ms.topic: article
66
---
77

8-
# Horizon API
8+
# Horizon API
99

1010
This guide describes commonly used Horizon methods.
1111

12-
### Getting more information
12+
## Getting more information
13+
14+
Defender for IoT APIs are governed by [Microsoft API License and Terms of use](/legal/microsoft-apis/terms-of-use).
1315

1416
For more information about working with Horizon and the Defender for IoT platform, see the following information:
1517

1618
- For the Horizon Open Development Environment (ODE) SDK, contact your Defender for IoT representative.
19+
1720
- For support and troubleshooting information, contact <[email protected]>.
1821

1922
- To access the Defender for IoT user guide from the Defender for IoT console, select :::image type="icon" source="media/references-horizon-api/profile.png"::: and then select **Download User Guide**.
2023

21-
2224
## `horizon::protocol::BaseParser`
2325

2426
Abstract for all plugins. This consists of two methods:
@@ -30,7 +32,7 @@ Abstract for all plugins. This consists of two methods:
3032

3133
The first function that is called for your plugin creates an instance of the parser for Horizon to recognize it and register it.
3234

33-
### Parameters
35+
### Parameters
3436

3537
None.
3638

@@ -40,15 +42,15 @@ shared_ptr to your parser instance.
4042

4143
## `std::vector<uint64_t> horizon::protocol::BaseParser::processDissectAs(const std::map<std::string, std::vector<std::string>> &) const`
4244

43-
This function will get called for each plugin registered above.
45+
This function will get called for each plugin registered above.
4446

4547
In most cases, this will be empty. Throw an exception for Horizon to know something bad happened.
4648

47-
### Parameters
49+
### Parameters
4850

4951
- A map containing the structure of dissect_as, as defined in the config.json of another plugin that wants to register over you.
5052

51-
### Return value
53+
### Return value
5254

5355
An array of uint64_t, which is the registration processed into a kind of uint64_t. This means in the map, you'll have a list of ports, whose values will be the uin64_t.
5456

@@ -65,7 +67,7 @@ Your plugin should be thread safe, as this function may be called from different
6567
- The SDK control unit responsible for storing the data and creating SDK-related objects, such as ILayer, and fields.
6668
- A helper for reading the data of the raw packet. It is already set with the byte order you defined in the config.json.
6769

68-
### Return value
70+
### Return value
6971

7072
The result of the processing. This can be either *Success*, *Malformed*, or *Sanity*.
7173

@@ -77,7 +79,7 @@ Marks the processing as sanitation failure, meaning the packet isn't recognized
7779

7880
Constructor
7981

80-
### Parameters
82+
### Parameters
8183

8284
- Defines the error code used by the Horizon for logging, as defined in the config.json.
8385

@@ -89,7 +91,7 @@ Malformed result, indicated we already recognized the packet as our protocol, bu
8991

9092
Constructor
9193

92-
### Parameters
94+
### Parameters
9395

9496
- Error code, as defined in config.json.
9597

@@ -105,7 +107,7 @@ Constructor. Created a basic successful result. This means we don't know the dir
105107

106108
Constructor.
107109

108-
### Parameters
110+
### Parameters
109111

110112
- The direction of packet, if identified. Values can be *REQUEST*, or *RESPONSE*.
111113

@@ -122,15 +124,15 @@ Constructor.
122124

123125
Constructor.
124126

125-
### Parameters
127+
### Parameters
126128

127-
- Warnings. These events won’t be failed, but Horizon will be notified.
129+
- Warnings. These events won’t be failed, but Horizon will be notified.
128130

129131
## `HorizonID HORIZON_FIELD(const std::string_view &)`
130132

131133
Converts a string-based reference to a field name (for example, function_code) to HorizonID.
132134

133-
### Parameters
135+
### Parameters
134136

135137
- String to convert.
136138

@@ -158,7 +160,7 @@ A reference to the manager.
158160

159161
Creates a new numeric field of 64 bits on the layer with the requested ID.
160162

161-
### Parameters
163+
### Parameters
162164

163165
- The layer you created earlier.
164166
- HorizonID created by the **HORIZON_FIELD** macro.
@@ -168,7 +170,7 @@ Creates a new numeric field of 64 bits on the layer with the requested ID.
168170

169171
Creates a new string field of on the layer with the requested ID. The memory will be moved, so be careful. You won't be able to use this value again.
170172

171-
### Parameters
173+
### Parameters
172174

173175
- The layer you created earlier.
174176
- HorizonID created by the **HORIZON_FIELD** macro.

articles/defender-for-iot/organizations/references-work-with-defender-for-iot-apis.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
22
title: Work with Defender for IoT APIs
33
description: Use an external REST API to access the data discovered by sensors and management consoles and perform actions with that data.
4-
ms.date: 10/17/2021
4+
ms.date: 11/08/2021
55
ms.topic: reference
66
---
77

88
# Defender for IoT sensor and management console APIs
99

10+
Defender for IoT APIs are governed by [Microsoft API License and Terms of use](/legal/microsoft-apis/terms-of-use).
11+
1012
Use an external REST API to access the data discovered by sensors and management consoles and perform actions with that data.
1113

1214
Connections are secured over SSL.

0 commit comments

Comments
 (0)