Skip to content

Commit 5e59860

Browse files
Add Iot Hub API categories to design doc (#11649)
1 parent 0d236d9 commit 5e59860

File tree

1 file changed

+73
-11
lines changed

1 file changed

+73
-11
lines changed

sdk/iot/Azure.Iot.Hub.Service/src/API Design.md

Lines changed: 73 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,86 @@
1-
1+
# Azure Iot Hub Service API Design Doc
2+
This document outlines the APIs for the Azure Iot Hub Service SDK
23

4+
<details><summary><b>Constructors</b></summary>
5+
6+
```csharp
37

8+
```
9+
</details>
410

5-
# Azure Iot Hub Service API Design Doc
6-
This document outlines the APIs for the Azure Iot Hub Service SDK
11+
<details><summary><b>Configurations</b></summary>
12+
APIs for managing configurations for devices and modules
13+
```csharp
714

8-
## Azure.Core usage
9-
Within this SDK, we will make use of several Azure.Core library classes
15+
```
16+
</details>
1017

11-
[AsyncPageable\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/AsyncPageable.cs): An enumerable set of items that are retrieved asynchronously over multiple http requests
18+
<details><summary><b>Statistics</b></summary>
19+
APIs for getting statistics about devices and modules, as well as service statistics
20+
```csharp
1221

13-
[Pageable\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Pageable.cs): An enumerable set of items that are retrieved synchronously over multiple http requests
22+
```
23+
</details>
1424

15-
[Page\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Page.cs): A single page within a Pageable. Should not be exposed to the user, since we strive to abstract out the pagination
25+
<details><summary><b>Registry</b></summary>
26+
APIs for managing device and module identities
27+
```csharp
1628

17-
[Response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Response.cs): Contains the raw HTTP response details
29+
```
30+
</details>
31+
32+
<details><summary><b>Jobs</b></summary>
33+
APIs for using IotHub jobs
34+
```csharp
35+
36+
```
37+
</details>
38+
39+
<details><summary><b>V2 Jobs</b></summary>
40+
(maybe combine with job APIs, or maybe don't expose v1 job APIs. Talk with service about this)
41+
42+
```csharp
43+
44+
```
45+
</details>
1846

19-
[Response\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Response%7BT%7D.cs): Contains a Response instance and a parsed type derived from that HTTP response (for instance, Response\<ModelData> when retrieving models)
20-
<details><summary><b>Sample</b></summary>
47+
<details><summary><b>Twin</b></summary>
48+
Device and module twin operations
49+
```csharp
50+
51+
```
52+
</details>
53+
54+
<details><summary><b>Methods</b></summary>
55+
Device and module direct methods
56+
```csharp
57+
58+
```
59+
</details>
60+
61+
<details><summary><b>Cloud to Device Messaging</b></summary>
62+
No sign of this in the swagger
63+
```csharp
64+
65+
```
66+
</details>
67+
68+
<details><summary><b>Feedback Message</b></summary>
69+
APIs for getting feedback messages
70+
```csharp
71+
72+
```
73+
</details>
74+
75+
<details><summary><b>File Upload Notifications</b></summary>
76+
No sign of this in the swagger
77+
```csharp
78+
79+
```
80+
</details>
2181

82+
<details><summary><b>Query</b></summary>
83+
APIs for querying on device or module identities
2284
```csharp
2385

2486
```

0 commit comments

Comments
 (0)