-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generated from 7311fd41d1714f152d4569e6641c8821a0273ae4 (#1382)
changes to improve documentation of endpoint health statuses for routing
- Loading branch information
1 parent
9d7d0b9
commit a35e414
Showing
9 changed files
with
234 additions
and
148 deletions.
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,21 +1,21 @@ | ||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) 2018 Microsoft | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| The MIT License (MIT) | ||
| Copyright (c) 2019 Microsoft | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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,96 +1,96 @@ | ||
| ## Azure IotHubClient SDK for JavaScript | ||
|
|
||
| This package contains an isomorphic SDK for IotHubClient. | ||
|
|
||
| ### Currently supported environments | ||
|
|
||
| - Node.js version 6.x.x or higher | ||
| - Browser JavaScript | ||
|
|
||
| ### How to Install | ||
|
|
||
| ``` | ||
| npm install @azure/arm-iothub | ||
| ``` | ||
|
|
||
| ### How to use | ||
|
|
||
| #### nodejs - Authentication, client creation and list operations as an example written in TypeScript. | ||
|
|
||
| ##### Install @azure/ms-rest-nodeauth | ||
|
|
||
| ``` | ||
| npm install @azure/ms-rest-nodeauth | ||
| ``` | ||
|
|
||
| ##### Sample code | ||
|
|
||
| ```ts | ||
| import * as msRest from "@azure/ms-rest-js"; | ||
| import * as msRestAzure from "@azure/ms-rest-azure-js"; | ||
| import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; | ||
| import { IotHubClient, IotHubModels, IotHubMappers } from "@azure/arm-iothub"; | ||
| const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; | ||
|
|
||
| msRestNodeAuth.interactiveLogin().then((creds) => { | ||
| const client = new IotHubClient(creds, subscriptionId); | ||
| client.operations.list().then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }); | ||
| }).catch((err) => { | ||
| console.error(err); | ||
| }); | ||
| ``` | ||
|
|
||
| #### browser - Authentication, client creation and list operations as an example written in JavaScript. | ||
|
|
||
| ##### Install @azure/ms-rest-browserauth | ||
|
|
||
| ``` | ||
| npm install @azure/ms-rest-browserauth | ||
| ``` | ||
|
|
||
| ##### Sample code | ||
|
|
||
| See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. | ||
|
|
||
| - index.html | ||
| ```html | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>@azure/arm-iothub sample</title> | ||
| <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script> | ||
| <script src="node_modules/@azure/arm-iothub/dist/arm-iothub.js"></script> | ||
| <script type="text/javascript"> | ||
| const subscriptionId = "<Subscription_Id>"; | ||
| const authManager = new msAuth.AuthManager({ | ||
| clientId: "<client id for your Azure AD app>", | ||
| tenant: "<optional tenant for your organization>" | ||
| }); | ||
| authManager.finalizeLogin().then((res) => { | ||
| if (!res.isLoggedIn) { | ||
| // may cause redirects | ||
| authManager.login(); | ||
| } | ||
| const client = new Azure.ArmIothub.IotHubClient(res.creds, subscriptionId); | ||
| client.operations.list().then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }).catch((err) => { | ||
| console.log("An error occurred:"); | ||
| console.error(err); | ||
| }); | ||
| }); | ||
| </script> | ||
| </head> | ||
| <body></body> | ||
| </html> | ||
| ``` | ||
|
|
||
| ## Related projects | ||
|
|
||
| - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) | ||
| ## Azure IotHubClient SDK for JavaScript | ||
|
|
||
| This package contains an isomorphic SDK for IotHubClient. | ||
|
|
||
| ### Currently supported environments | ||
|
|
||
| - Node.js version 6.x.x or higher | ||
| - Browser JavaScript | ||
|
|
||
| ### How to Install | ||
|
|
||
| ```bash | ||
| npm install @azure/arm-iothub | ||
| ``` | ||
|
|
||
| ### How to use | ||
|
|
||
| #### nodejs - Authentication, client creation and list operations as an example written in TypeScript. | ||
|
|
||
| ##### Install @azure/ms-rest-nodeauth | ||
|
|
||
| ```bash | ||
| npm install @azure/ms-rest-nodeauth | ||
| ``` | ||
|
|
||
| ##### Sample code | ||
|
|
||
| ```typescript | ||
| import * as msRest from "@azure/ms-rest-js"; | ||
| import * as msRestAzure from "@azure/ms-rest-azure-js"; | ||
| import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; | ||
| import { IotHubClient, IotHubModels, IotHubMappers } from "@azure/arm-iothub"; | ||
| const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; | ||
|
|
||
| msRestNodeAuth.interactiveLogin().then((creds) => { | ||
| const client = new IotHubClient(creds, subscriptionId); | ||
| client.operations.list().then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }); | ||
| }).catch((err) => { | ||
| console.error(err); | ||
| }); | ||
| ``` | ||
|
|
||
| #### browser - Authentication, client creation and list operations as an example written in JavaScript. | ||
|
|
||
| ##### Install @azure/ms-rest-browserauth | ||
|
|
||
| ```bash | ||
| npm install @azure/ms-rest-browserauth | ||
| ``` | ||
|
|
||
| ##### Sample code | ||
|
|
||
| See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. | ||
|
|
||
| - index.html | ||
| ```html | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>@azure/arm-iothub sample</title> | ||
| <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script> | ||
| <script src="node_modules/@azure/arm-iothub/dist/arm-iothub.js"></script> | ||
| <script type="text/javascript"> | ||
| const subscriptionId = "<Subscription_Id>"; | ||
| const authManager = new msAuth.AuthManager({ | ||
| clientId: "<client id for your Azure AD app>", | ||
| tenant: "<optional tenant for your organization>" | ||
| }); | ||
| authManager.finalizeLogin().then((res) => { | ||
| if (!res.isLoggedIn) { | ||
| // may cause redirects | ||
| authManager.login(); | ||
| } | ||
| const client = new Azure.ArmIothub.IotHubClient(res.creds, subscriptionId); | ||
| client.operations.list().then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }).catch((err) => { | ||
| console.log("An error occurred:"); | ||
| console.error(err); | ||
| }); | ||
| }); | ||
| </script> | ||
| </head> | ||
| <body></body> | ||
| </html> | ||
| ``` | ||
|
|
||
| ## Related projects | ||
|
|
||
| - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) |
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
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
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
Oops, something went wrong.