Skip to content
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.

Sign up for GitHub

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

Improve API documentation #735

Merged
merged 4 commits into from
Mar 20, 2020
Merged

Improve API documentation #735

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b65b3d7
Improve documentation for new APIs
bikamani Mar 16, 2020
f02a598
Improve documentation for new APIs
bikamani Mar 16, 2020
ed8e63c
fix typo
bikamani Mar 17, 2020
f9f1513
Merge branch 'master' into bikamani/identitybasedDoc
timtay-microsoft Mar 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ...iot-service-client/src/main/java/com/microsoft/azure/sdk/iot/service/RegistryManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,11 @@ public CompletableFuture<JobProperties> exportDevicesAsync(String exportBlobCont
* Create a bulk export job.
*
* @param exportDevicesParameters A JobProperties object containing input parameters for export Devices job
* This API also supports identity bases storage authentication, identity authentication
bikamani marked this conversation as resolved.
Show resolved Hide resolved
* support is currently available in limited regions. If a user wishes to try it out,
* they will need to set an Environment Variable of "EnabledStorageIdentity" and set it to "1"
* otherwise default key based authentication is used for storage
* <a href="https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support"> More details here </a>
*
* @return A JobProperties object for the newly created bulk export job
*
Expand Down Expand Up @@ -754,6 +759,11 @@ public JobProperties exportDevices(JobProperties exportDevicesParameters)
/**
* Async wrapper for exportDevices() operation
* @param exportDevicesParameters A JobProperties object containing input parameters for export Devices job
* This API also supports identity bases storage authentication, identity authentication
* support is currently available in limited regions. If a user wishes to try it out,
* they will need to set an Environment Variable of "EnabledStorageIdentity" and set it to "1"
* otherwise default key based authentication is used for storage
* <a href="https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support"> More details here </a>
* @return The future object for the requested operation
*
* @throws IllegalArgumentException This exception is thrown if the exportBlobContainerUri or excludeKeys parameters are null
Expand Down Expand Up @@ -856,6 +866,11 @@ public CompletableFuture<JobProperties> importDevicesAsync(String importBlobCont
* Create a bulk import job.
*
* @param importDevicesParameters A JobProperties object containing input parameters for import Devices job
* This API also supports identity bases storage authentication, identity authentication
* support is currently available in limited regions. If a user wishes to try it out,
* they will need to set an Environment Variable of "EnabledStorageIdentity" and set it to "1"
* otherwise default key based authentication is used for storage
* <a href="https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support"> More details here </a>
*
* @return A JobProperties object for the newly created bulk import job
*
Expand Down Expand Up @@ -889,6 +904,11 @@ public JobProperties importDevices(JobProperties importDevicesParameters)
* Async wrapper for importDevices() operation
*
* @param importParameters A JobProperties object containing input parameters for import Devices job
* This API also supports identity bases storage authentication, identity authentication
* support is currently available in limited regions. If a user wishes to try it out,
* they will need to set an Environment Variable of "EnabledStorageIdentity" and set it to "1"
* otherwise default key based authentication is used for storage
* <a href="https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support"> More details here </a>
* @return The future object for the requested operation
*
* @throws IllegalArgumentException This exception is thrown if the exportBlobContainerUri or excludeKeys parameters are null
Expand Down