-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Iot Hub API categories to design doc #11649
Merged
timtay-microsoft
merged 5 commits into
feature/iot/abmisr/initProject
from
feature/iot/timtay/initProject
Apr 28, 2020
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,86 @@ | ||
| ||
# Azure Iot Hub Service API Design Doc | ||
This document outlines the APIs for the Azure Iot Hub Service SDK | ||
|
||
<details><summary><b>Constructors</b></summary> | ||
|
||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
# Azure Iot Hub Service API Design Doc | ||
This document outlines the APIs for the Azure Iot Hub Service SDK | ||
<details><summary><b>Configurations</b></summary> | ||
APIs for managing configurations for devices and modules | ||
```csharp | ||
|
||
## Azure.Core usage | ||
Within this SDK, we will make use of several Azure.Core library classes | ||
``` | ||
</details> | ||
|
||
[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 | ||
<details><summary><b>Statistics</b></summary> | ||
APIs for getting statistics about devices and modules, as well as service statistics | ||
```csharp | ||
|
||
[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 | ||
``` | ||
</details> | ||
|
||
[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 | ||
<details><summary><b>Registry</b></summary> | ||
APIs for managing device and module identities | ||
```csharp | ||
|
||
[Response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Response.cs): Contains the raw HTTP response details | ||
``` | ||
</details> | ||
|
||
<details><summary><b>Jobs</b></summary> | ||
APIs for using IotHub jobs | ||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
<details><summary><b>V2 Jobs</b></summary> | ||
(maybe combine with job APIs, or maybe don't expose v1 job APIs. Talk with service about this) | ||
|
||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
[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) | ||
<details><summary><b>Sample</b></summary> | ||
<details><summary><b>Twin</b></summary> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. note - Device and module twin operations |
||
Device and module twin operations | ||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
<details><summary><b>Methods</b></summary> | ||
Device and module direct methods | ||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
<details><summary><b>Cloud to Device Messaging</b></summary> | ||
No sign of this in the swagger | ||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
<details><summary><b>Feedback Message</b></summary> | ||
APIs for getting feedback messages | ||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
<details><summary><b>File Upload Notifications</b></summary> | ||
No sign of this in the swagger | ||
```csharp | ||
|
||
``` | ||
</details> | ||
|
||
<details><summary><b>Query</b></summary> | ||
APIs for querying on device or module identities | ||
```csharp | ||
|
||
``` | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A note here, stating that these relate to IoT Hub identity registry operation, would give some additional context.