Skip to content

Commit

Permalink
Update docs metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
azure-sdk committed Dec 21, 2022
1 parent 6c5fdfb commit bce09a4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,31 @@ title: Azure iotHub client library for JavaScript
keywords: Azure, javascript, SDK, API, @azure/arm-iothub-profile-2020-09-01-hybrid, iothub
author: qiaozha
ms.author: qiaozha
ms.date: 03/11/2022
ms.date: 12/21/2022
ms.topic: reference
ms.prod: azure
ms.technology: azure
ms.devlang: javascript
ms.service: iothub
---
# Azure iotHub client library for JavaScript - version 2.0.0
# Azure iotHub client library for JavaScript - version 2.1.0


This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure iotHub client.

Use this API to manage the IoT hubs in your Azure subscription.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.0.0/sdk/iothub/arm-iothub-profile-2020-09-01-hybrid) |
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.1.0/sdk/iothub/arm-iothub-profile-2020-09-01-hybrid) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-iothub-profile-2020-09-01-hybrid) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-iothub-profile-2020-09-01-hybrid?view=azure-node-preview) |
[API reference documentation](/javascript/api/@azure/arm-iothub-profile-2020-09-01-hybrid?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started

### Currently supported environments

- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
- Latest versions of Safari, Chrome, Edge and Firefox.

See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-iothub-profile-2020-09-01-hybrid_2.0.0/SUPPORT.md) for more details.
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-iothub-profile-2020-09-01-hybrid_2.1.0/SUPPORT.md) for more details.

### Prerequisites

Expand All @@ -48,7 +46,7 @@ npm install @azure/arm-iothub-profile-2020-09-01-hybrid
To create a client object to access the Azure iotHub API, you will need the `endpoint` of your Azure iotHub resource and a `credential`. The Azure iotHub client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure iotHub resource in the [Azure Portal][azure_portal].

You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-iothub-profile-2020-09-01-hybrid_2.0.0/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-iothub-profile-2020-09-01-hybrid_2.1.0/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).

To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:

Expand All @@ -59,7 +57,7 @@ npm install @azure/identity
You will also need to **register a new AAD application and grant access to Azure iotHub** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { IotHubClient } = require("@azure/arm-iothub-profile-2020-09-01-hybrid");
Expand Down Expand Up @@ -98,26 +96,26 @@ const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
```

For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.0.0/sdk/core/logger).
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.1.0/sdk/core/logger).

## Next steps

Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.

## Contributing

If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-iothub-profile-2020-09-01-hybrid_2.0.0/CONTRIBUTING.md) to learn more about how to build and test the code.
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-iothub-profile-2020-09-01-hybrid_2.1.0/CONTRIBUTING.md) to learn more about how to build and test the code.

## Related projects

- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fiothub%2Farm-iothub-profile-2020-09-01-hybrid%2FREADME.png)

[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_cli]: /cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.0.0/sdk/identity/identity
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.0.0/sdk/identity/identity#defaultazurecredential
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.1.0/sdk/identity/identity
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-iothub-profile-2020-09-01-hybrid_2.1.0/sdk/identity/identity#defaultazurecredential

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"Name": "@azure/arm-iothub-profile-2020-09-01-hybrid",
"Version": "2.0.0",
"Version": "2.1.0",
"DevVersion": null,
"DirectoryPath": "sdk/iothub/arm-iothub-profile-2020-09-01-hybrid",
"ServiceDirectory": "iothub",
Expand All @@ -10,5 +10,5 @@
"SdkType": "mgmt",
"IsNewSdk": true,
"ArtifactName": "azure-arm-iothub-profile-2020-09-01-hybrid",
"ReleaseStatus": "2022-03-11"
"ReleaseStatus": "2022-12-20"
}

0 comments on commit bce09a4

Please sign in to comment.