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
Copy file name to clipboardExpand all lines: articles/defender-for-iot/device-builders/azure-rtos-security-module-api.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ ms.author: mlottner
9
9
10
10
# Defender-IoT-micro-agent for Azure RTOS API (preview)
11
11
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).
13
15
14
16
## Enable Defender-IoT-micro-agent for Azure RTOS
15
17
@@ -47,7 +49,6 @@ Threads
47
49
48
50
**nx_azure_iot_security_module_disable**
49
51
50
-
51
52
### Prototype
52
53
53
54
```c
@@ -76,7 +77,6 @@ This routine disables the Azure IoT Defender-IoT-micro-agent subsystem.
76
77
77
78
Threads
78
79
79
-
80
80
## Next steps
81
81
82
82
To learn more about how to get started with Azure RTOS Defender-IoT-micro-agent, see the following articles:
Copy file name to clipboardExpand all lines: articles/defender-for-iot/organizations/references-horizon-api.md
+18-16Lines changed: 18 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,20 +5,22 @@ ms.date: 1/5/2021
5
5
ms.topic: article
6
6
---
7
7
8
-
# Horizon API
8
+
# Horizon API
9
9
10
10
This guide describes commonly used Horizon methods.
11
11
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).
13
15
14
16
For more information about working with Horizon and the Defender for IoT platform, see the following information:
15
17
16
18
- For the Horizon Open Development Environment (ODE) SDK, contact your Defender for IoT representative.
19
+
17
20
- For support and troubleshooting information, contact <[email protected]>.
18
21
19
22
- 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**.
20
23
21
-
22
24
## `horizon::protocol::BaseParser`
23
25
24
26
Abstract for all plugins. This consists of two methods:
@@ -30,7 +32,7 @@ Abstract for all plugins. This consists of two methods:
30
32
31
33
The first function that is called for your plugin creates an instance of the parser for Horizon to recognize it and register it.
32
34
33
-
### Parameters
35
+
### Parameters
34
36
35
37
None.
36
38
@@ -40,15 +42,15 @@ shared_ptr to your parser instance.
This function will get called for each plugin registered above.
45
+
This function will get called for each plugin registered above.
44
46
45
47
In most cases, this will be empty. Throw an exception for Horizon to know something bad happened.
46
48
47
-
### Parameters
49
+
### Parameters
48
50
49
51
- A map containing the structure of dissect_as, as defined in the config.json of another plugin that wants to register over you.
50
52
51
-
### Return value
53
+
### Return value
52
54
53
55
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.
54
56
@@ -65,7 +67,7 @@ Your plugin should be thread safe, as this function may be called from different
65
67
- The SDK control unit responsible for storing the data and creating SDK-related objects, such as ILayer, and fields.
66
68
- A helper for reading the data of the raw packet. It is already set with the byte order you defined in the config.json.
67
69
68
-
### Return value
70
+
### Return value
69
71
70
72
The result of the processing. This can be either *Success*, *Malformed*, or *Sanity*.
71
73
@@ -77,7 +79,7 @@ Marks the processing as sanitation failure, meaning the packet isn't recognized
77
79
78
80
Constructor
79
81
80
-
### Parameters
82
+
### Parameters
81
83
82
84
- Defines the error code used by the Horizon for logging, as defined in the config.json.
83
85
@@ -89,7 +91,7 @@ Malformed result, indicated we already recognized the packet as our protocol, bu
89
91
90
92
Constructor
91
93
92
-
### Parameters
94
+
### Parameters
93
95
94
96
- Error code, as defined in config.json.
95
97
@@ -105,7 +107,7 @@ Constructor. Created a basic successful result. This means we don't know the dir
105
107
106
108
Constructor.
107
109
108
-
### Parameters
110
+
### Parameters
109
111
110
112
- The direction of packet, if identified. Values can be *REQUEST*, or *RESPONSE*.
111
113
@@ -122,15 +124,15 @@ Constructor.
122
124
123
125
Constructor.
124
126
125
-
### Parameters
127
+
### Parameters
126
128
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.
0 commit comments