Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@
# PRLabel: %Mgmt %mgmt-review-needed
/sdk/iotoperations/arm-iotoperations/ @qiaozha @MaryGao @JialinHuang803

# PRLabel: %Mgmt
# PRLabel: %Mgmt %mgmt-review-needed
/sdk/iothub/arm-iothub/ @qiaozha @MaryGao @JialinHuang803

# PRLabel: %Mgmt
Expand Down
22 changes: 11 additions & 11 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

68 changes: 68 additions & 0 deletions sdk/iothub/arm-iothub/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,73 @@
# Release History

## 7.0.0-beta.2 (2026-06-05)
Compared with version 6.3.0
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔴 Tool IssueCHANGELOG.md:4

Compared with version 6.3.0

The new 7.0.0-beta.2 entry compares against the stable baseline 6.3.0 rather than the immediately preceding beta 7.0.0-beta.1. This causes the diff to re-list changes that were already documented in 7.0.0-beta.1, making the changelog misleading.

Fix: Update this line to read Compared with version 7.0.0-beta.1, and report the issue in the generation tool repository.


### Features Added
- Added operation IotHubOperations.manualFailover
- Added operation IotHubResourceOperations.createOrUpdate
- Added operation IotHubResourceOperations.delete
- Added operation IotHubResourceOperations.update
- Added operation PrivateEndpointConnectionsOperations.delete
- Added operation PrivateEndpointConnectionsOperations.update
- Class IotHubClient has a new constructor "constructor(credential: TokenCredential, options?: IotHubClientOptionalParams);"
- Added Interface DeviceRegistry
- Added Interface EncryptionPropertiesDescription
- Added Interface IotHubDetails
- Added Interface IotHubPropertiesDeviceStreams
- Added Interface IotHubResourceListEndpointHealthOptionalParams
- Added Interface IotHubResourceListQuotaMetricsOptionalParams
- Added Interface IotHubResourceListValidSkusOptionalParams
- Added Interface KeyVaultKeyProperties
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface ProxyResource
- Added Interface RestorePollerOptions
- Added Interface RootCertificateProperties
- Added Interface SimplePollerLike
- Added Interface TrackedResource
- Interface CertificateDescription has a new optional parameter systemData
- Interface CertificateProperties has a new optional parameter policyResourceId
- Interface CertificatePropertiesWithNonce has a new optional parameter policyResourceId
- Interface EventHubConsumerGroupInfo has a new optional parameter systemData
- Interface IotHubProperties has a new optional parameter deviceHostName
- Interface IotHubProperties has a new optional parameter deviceRegistry
- Interface IotHubProperties has a new optional parameter deviceStreams
- Interface IotHubProperties has a new optional parameter encryption
- Interface IotHubProperties has a new optional parameter iotHubDetails
- Interface IotHubProperties has a new optional parameter ipVersion
- Interface IotHubProperties has a new optional parameter rootCertificate
- Interface IotHubProperties has a new optional parameter serviceHostName
- Interface PrivateEndpointConnection has a new optional parameter systemData
- Interface Resource has a new optional parameter systemData
- Added Type Alias AzureSupportedClouds
- Added Type Alias GatewayVersion
- Added Type Alias IpVersion
- Added Enum AzureClouds
- Added Enum KnownGatewayVersion
- Added Enum KnownIpVersion
- Added Enum KnownVersions
- Enum KnownIotHubSku has a new value GEN2
- Enum KnownRoutingSource has a new value DigitalTwinChangeEvents
- Enum KnownRoutingSource has a new value MqttBrokerMessages

### Breaking Changes
- Operation IotHubResource.beginCreateOrUpdate has a new signature
- Operation IotHubResource.beginCreateOrUpdateAndWait has a new signature
- Operation IotHubResource.beginDeleteAndWait has a new signature
- Operation IotHubResource.beginUpdateAndWait has a new signature
- Operation IotHubResource.get has a new signature
- Class IotHubClient no longer has parameter apiVersion
- Class IotHubClient no longer has parameter privateLinkResourcesOperations
- Class IotHubClient no longer has parameter subscriptionId
- Removed Interface CertificateBodyDescription
- Removed Interface IotHubResourceGetEndpointHealthOptionalParams
- Removed Interface IotHubResourceGetQuotaMetricsOptionalParams
- Removed Interface IotHubResourceGetValidSkusOptionalParams
- Interface Resource no longer has parameter location
- Interface Resource no longer has parameter tags
- Type alias "IotHubSkuTier" has been changed

## 7.0.0-beta.1 (2025-11-06)
Compared with version 6.3.0

Expand Down
34 changes: 17 additions & 17 deletions sdk/iothub/arm-iothub/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Azure iotHub client library for JavaScript
# Azure IotHub client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure iotHub client.
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/main/sdk/iothub/arm-iothub) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-iothub) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-iothub?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/iothub/arm-iothub)
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-iothub)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-iothub?view=azure-node-preview)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/iothub/arm-iothub/samples)

## Getting started

Expand All @@ -24,26 +26,26 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP

### Install the `@azure/arm-iothub` package

Install the Azure iotHub client library for JavaScript with `npm`:
Install the Azure IotHub client library for JavaScript with `npm`:

```bash
npm install @azure/arm-iothub
```

### Create and authenticate a `IotHubClient`

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].
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/master/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/main/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:

```bash
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).
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).

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

Expand All @@ -63,22 +65,23 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { IotHubClient } from "@azure/arm-iothub";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new IotHubClient(credential, subscriptionId);
```


### JavaScript Bundle
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts

### IotHubClient

`IotHubClient` is the primary interface for developers using the Azure iotHub client library. Explore the methods on this client object to understand the different features of the Azure iotHub service that you can access.
`IotHubClient` is the primary interface for developers using the Azure IotHub client library. Explore the methods on this client object to understand the different features of the Azure IotHub service that you can access.

## Troubleshooting

Expand All @@ -96,7 +99,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur

## 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.
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/iothub/arm-iothub/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -106,9 +109,6 @@ If you'd like to contribute to this library, please read the [contributing guide

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


[azure_cli]: https://learn.microsoft.com/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/main/sdk/identity/identity
Expand Down
9 changes: 0 additions & 9 deletions sdk/iothub/arm-iothub/_meta.json

This file was deleted.

4 changes: 1 addition & 3 deletions sdk/iothub/arm-iothub/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
{
"extends": "../../../api-extractor-base.json"
}
{ "extends": "../../../api-extractor-base.json" }
5 changes: 1 addition & 4 deletions sdk/iothub/arm-iothub/config/tsconfig.lint.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
{
"extends": "../../../../tsconfig.json",
"include": [
"../src",
"../test"
]
"include": ["../src", "../test"]
}
4 changes: 1 addition & 3 deletions sdk/iothub/arm-iothub/config/tsconfig.samples.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
"extends": "../../../../eng/tsconfigs/samples.json",
"compilerOptions": {
"paths": {
"@azure/arm-iothub": [
"../dist/esm"
]
"@azure/arm-iothub": ["../dist/esm"]
}
}
}
4 changes: 1 addition & 3 deletions sdk/iothub/arm-iothub/config/tsconfig.src.browser.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.browser.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
4 changes: 1 addition & 3 deletions sdk/iothub/arm-iothub/config/tsconfig.src.cjs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.cjs.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
4 changes: 1 addition & 3 deletions sdk/iothub/arm-iothub/config/tsconfig.src.esm.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.esm.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
10 changes: 10 additions & 0 deletions sdk/iothub/arm-iothub/config/tsconfig.test.browser.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.browser.json",
"compilerOptions": {
"paths": {
"@azure/arm-iothub": ["../src/index.ts"],
"@azure/arm-iothub/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
9 changes: 8 additions & 1 deletion sdk/iothub/arm-iothub/config/tsconfig.test.node.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.node.json"
"extends": "../../../../eng/tsconfigs/test.node.json",
"compilerOptions": {
"paths": {
"@azure/arm-iothub": ["../src/index.ts"],
"@azure/arm-iothub/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
Loading
Loading