Skip to content

Commit 0939b27

Browse files
Merge pull request Azure#1830 from azure-sdk/onboarding-azure-resourcemanager-iothub-759758
Docs.MS Release Updates for azure-resourcemanager-iothub
2 parents 77eb434 + 053d558 commit 0939b27

File tree

2 files changed

+123
-0
lines changed

2 files changed

+123
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
title: Azure Resource Manager IotHub client library for Java
3+
keywords: Azure, java, SDK, API, azure-resourcemanager-iothub,
4+
author: maggiepint
5+
ms.author: magpint
6+
ms.date: 03/02/2021
7+
ms.topic: article
8+
ms.prod: azure
9+
ms.technology: azure
10+
ms.devlang: java
11+
ms.service:
12+
---
13+
14+
# Azure Resource Manager IotHub client library for Java - Version 1.0.0-beta.1
15+
16+
17+
Azure Resource Manager IotHub client library for Java.
18+
19+
This package contains Microsoft Azure SDK for IotHub Management SDK. Use this API to manage the IoT hubs in your Azure subscription. Package tag package-2020-03. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).
20+
21+
## We'd love to hear your feedback
22+
23+
We're always working on improving our products and the way we communicate with our users. So we'd love to learn what's working and how we can do better.
24+
25+
If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together.
26+
27+
Thank you in advance for your collaboration. We really appreciate your time!
28+
29+
## Documentation
30+
31+
Various documentation is available to help you get started
32+
33+
- [API reference documentation][docs]
34+
35+
## Getting started
36+
37+
### Prerequisites
38+
39+
- [Java Development Kit (JDK)][jdk] with version 8 or above
40+
- [Azure Subscription][azure_subscription]
41+
42+
### Adding the package to your product
43+
44+
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-iothub;current})
45+
```xml
46+
<dependency>
47+
<groupId>com.azure.resourcemanager</groupId>
48+
<artifactId>azure-resourcemanager-iothub</artifactId>
49+
<version>1.0.0-beta.1</version>
50+
</dependency>
51+
```
52+
[//]: # ({x-version-update-end})
53+
54+
### Include the recommended packages
55+
56+
Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.
57+
58+
[Azure Identity][azure_identity] package and [Azure Core Netty HTTP][azure_core_http_netty] package provide the default implementation.
59+
60+
### Authentication
61+
62+
By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
63+
64+
- `AZURE_CLIENT_ID` for Azure client ID.
65+
- `AZURE_TENANT_ID` for Azure tenant ID.
66+
- `AZURE_CLIENT_SECRET` or `AZURE_CLIENT_CERTIFICATE_PATH` for client secret or client certificate.
67+
68+
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
69+
70+
With above configuration, `azure` client can be authenticated by following code:
71+
72+
```java
73+
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
74+
TokenCredential credential = new DefaultAzureCredentialBuilder()
75+
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
76+
.build();
77+
IotHubManager manager = IotHubManager
78+
.authenticate(credential, profile);
79+
```
80+
81+
The sample code assumes global Azure. Please change `AzureEnvironment.AZURE` variable if otherwise.
82+
83+
See [Authentication][authenticate] for more options.
84+
85+
## Key concepts
86+
87+
See [API design][design] for general introduction on design and key concepts on Azure Management Libraries.
88+
89+
## Examples
90+
91+
## Troubleshooting
92+
93+
## Next steps
94+
95+
## Contributing
96+
97+
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-iothub_1.0.0-beta.1/CONTRIBUTING.md).
98+
99+
1. Fork it
100+
1. Create your feature branch (`git checkout -b my-new-feature`)
101+
1. Commit your changes (`git commit -am 'Add some feature'`)
102+
1. Push to the branch (`git push origin my-new-feature`)
103+
1. Create new Pull Request
104+
105+
<!-- LINKS -->
106+
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS
107+
[docs]: https://azure.github.io/azure-sdk-for-java/
108+
[jdk]: https://docs.microsoft.com/java/azure/jdk/
109+
[azure_subscription]: https://azure.microsoft.com/free/
110+
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-iothub_1.0.0-beta.1/sdk/identity/azure-identity
111+
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-iothub_1.0.0-beta.1/sdk/core/azure-core-http-netty
112+
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-iothub_1.0.0-beta.1/sdk/resourcemanager/docs/AUTH.md
113+
[design]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-iothub_1.0.0-beta.1/sdk/resourcemanager/docs/DESIGN.md
114+

package.json

+9
Original file line numberDiff line numberDiff line change
@@ -2000,6 +2000,15 @@
20002000
"inputPath": [],
20012001
"excludePath": [],
20022002
"excludepackages": "com.azure.resourcemanager.digitaltwins.implementation"
2003+
},
2004+
{
2005+
"packageGroupId": "com.azure.resourcemanager",
2006+
"packageArtifactId": "azure-resourcemanager-iothub",
2007+
"packageDownloadUrl": "https://repo1.maven.org/maven2",
2008+
"inputPath": [],
2009+
"packageVersion": "1.0.0-beta.1",
2010+
"excludePath": [],
2011+
"excludepackages": "com.azure.resourcemanager.iothub.implementation"
20032012
}
20042013
]
20052014
}

0 commit comments

Comments
 (0)