Skip to content

Commit 1515ea3

Browse files
committed
Update docs metadata
1 parent 937b2a6 commit 1515ea3

File tree

2 files changed

+46
-10
lines changed

2 files changed

+46
-10
lines changed

docs-ref-services/preview/mgmt-iothubprovisioningservices-readme.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title:
33
keywords: Azure, python, SDK, API, azure-mgmt-iothubprovisioningservices, iothub
44
author: lmazuel
55
ms.author: lmazuel
6-
ms.date: 11/17/2022
6+
ms.date: 06/21/2023
77
ms.topic: reference
88
ms.devlang: python
99
ms.service: iothub
@@ -18,17 +18,53 @@ For a more complete view of Azure libraries, see the [azure sdk python release](
1818

1919
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
2020

21-
# Usage
21+
## Getting started
2222

23+
### Prerequisites
2324

24-
To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt)
25-
26-
For docs and references, see [Python SDK References](/python/api/overview/azure/iot)
27-
Code samples for this package can be found at [IoT Hub Provisioning Services](/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
28-
Additional code samples for different Azure services are available at [Samples Repo](https://github.com/Azure-Samples/azure-samples-python-management/tree/main/samples/iothubprovisioningservices)
25+
- Python 3.7+ is required to use this package.
26+
- [Azure subscription](https://azure.microsoft.com/free/)
2927

28+
### Install the package
3029

31-
# Provide Feedback
30+
```bash
31+
pip install azure-mgmt-iothubprovisioningservices
32+
pip install azure-identity
33+
```
34+
35+
### Authentication
36+
37+
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.
38+
39+
- `AZURE_CLIENT_ID` for Azure client ID.
40+
- `AZURE_TENANT_ID` for Azure tenant ID.
41+
- `AZURE_CLIENT_SECRET` for Azure client secret.
42+
43+
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
44+
45+
With above configuration, client can be authenticated by following code:
46+
47+
```python
48+
from azure.identity import DefaultAzureCredential
49+
from azure.mgmt.iothubprovisioningservices import IotDpsClient
50+
import os
51+
52+
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
53+
client = IotDpsClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
54+
```
55+
56+
## Examples
57+
58+
Code samples for this package can be found at:
59+
- [Search IoT Hub Provisioning Services](/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
60+
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
61+
62+
63+
## Troubleshooting
64+
65+
## Next steps
66+
67+
## Provide Feedback
3268

3369
If you encounter any bugs or have suggestions, please file an issue in the
3470
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-mgmt-iothubprovisioningservices",
3-
"Version": "1.2.0b1",
3+
"Version": "1.2.0b2",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/iothub/azure-mgmt-iothubprovisioningservices",
66
"ServiceDirectory": "iothub",
@@ -10,5 +10,5 @@
1010
"SdkType": "mgmt",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-mgmt-iothubprovisioningservices",
13-
"ReleaseStatus": "2022-11-15"
13+
"ReleaseStatus": "2023-06-16"
1414
}

0 commit comments

Comments
 (0)