Repository navigation
[AutoPR azure-iot-deviceregistrysoftwareupdate]-generated-from-SDK Generation - Python-6732412 #48623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Austin Wu (wuqiten)
merged 13 commits into
main
from
sdkauto/azure-iot-deviceregistrysoftwareupdate-6715277
Sep 4, 2026
+11,261
−0
Merged
[AutoPR azure-iot-deviceregistrysoftwareupdate]-generated-from-SDK Generation - Python-6732412 #48623
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
b12feb4
Configurations: 'specification/deviceupdate/data-plane/sudeviceregis…
azure-sdk bf22c12
Configurations: 'specification/deviceupdate/data-plane/sudeviceregis…
azure-sdk 651c17e
Fix device registry spell check overrides
wuqiten 7313818
Address device registry review feedback
wuqiten e16ca84
Add required device registry README sections
wuqiten 49ac8e9
Use absolute API reference link
wuqiten 6c4a1b7
Configurations: 'specification/deviceupdate/data-plane/sudeviceregis…
azure-sdk a556cba
Configurations: 'specification/deviceupdate/data-plane/sudeviceregis…
azure-sdk fadffd5
Fix software update model customizations
wuqiten 30d2502
Fix protected access Pylint warning
wuqiten 8365d0c
Improve Software Update README
wuqiten 15f12ab
Add software update recorded tests
wuqiten 716219b
update readme
wuqiten File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
sdk/deviceregistry/azure-iot-deviceregistrysoftwareupdate/CHANGELOG.md
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Release History | ||
|
|
||
| ## 1.0.0b1 (2026-08-18) | ||
|
|
||
| ### Other Changes | ||
|
|
||
| - Initial version |
21 changes: 21 additions & 0 deletions
21
sdk/deviceregistry/azure-iot-deviceregistrysoftwareupdate/LICENSE
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| Copyright (c) Microsoft Corporation. | ||
|
|
||
| MIT License | ||
|
|
||
| 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. |
7 changes: 7 additions & 0 deletions
7
sdk/deviceregistry/azure-iot-deviceregistrysoftwareupdate/MANIFEST.in
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| include *.md | ||
| include LICENSE | ||
| include azure/iot/deviceregistrysoftwareupdate/py.typed | ||
| recursive-include tests *.py | ||
| recursive-include samples *.py *.md | ||
| include azure/__init__.py | ||
| include azure/iot/__init__.py |
90 changes: 90 additions & 0 deletions
90
sdk/deviceregistry/azure-iot-deviceregistrysoftwareupdate/README.md
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Azure Iot Deviceregistrysoftwareupdate client library for Python | ||
| <!-- write necessary description of service --> | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Install the package | ||
|
|
||
| ```bash | ||
| python -m pip install azure-iot-deviceregistrysoftwareupdate | ||
| ``` | ||
|
|
||
| #### Prerequisites | ||
|
|
||
| - Python 3.10 or later is required to use this package. | ||
| - You need an [Azure subscription][azure_sub] to use this package. | ||
| - An existing Azure Iot Deviceregistrysoftwareupdate instance. | ||
|
|
||
| ### Use with AI tools | ||
|
|
||
| AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See [Using the Azure SDK for Python with AI tools](https://aka.ms/azsdk/python/ai) for available integrations. | ||
|
|
||
| #### Create with an Azure Active Directory Credential | ||
| To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], | ||
| provide an instance of the desired credential type obtained from the | ||
| [azure-identity][azure_identity_credentials] library. | ||
|
|
||
| To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] | ||
|
|
||
| After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. | ||
| As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client: | ||
|
|
||
| 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` | ||
|
|
||
| Use the returned token credential to authenticate the client: | ||
|
|
||
| ```python | ||
| >>> from azure.iot.deviceregistrysoftwareupdate import DeviceRegistrySoftwareUpdateClient | ||
| >>> from azure.identity import DefaultAzureCredential | ||
| >>> client = DeviceRegistrySoftwareUpdateClient(endpoint='<endpoint>', credential=DefaultAzureCredential()) | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
|
wuqiten marked this conversation as resolved.
|
||
| ```python | ||
| import os | ||
|
|
||
| from azure.core.exceptions import HttpResponseError | ||
| from azure.identity import DefaultAzureCredential | ||
| from azure.iot.deviceregistrysoftwareupdate import DeviceRegistrySoftwareUpdateClient | ||
|
|
||
| endpoint = os.environ["DEVICE_REGISTRY_SOFTWARE_UPDATE_ENDPOINT"] | ||
|
|
||
| try: | ||
| with DeviceRegistrySoftwareUpdateClient( | ||
| endpoint=endpoint, | ||
| credential=DefaultAzureCredential(), | ||
| ) as client: | ||
| for device_class in client.device_classes.list(): | ||
| print(device_class) | ||
| except HttpResponseError as error: | ||
| print(f"Service request failed: {error}") | ||
|
|
||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require | ||
| you to agree to a Contributor License Agreement (CLA) declaring that you have | ||
| the right to, and actually do, grant us the rights to use your contribution. | ||
| For details, visit https://cla.microsoft.com. | ||
|
|
||
| When you submit a pull request, a CLA-bot will automatically determine whether | ||
| you need to provide a CLA and decorate the PR appropriately (e.g., label, | ||
| comment). Simply follow the instructions provided by the bot. You will only | ||
| need to do this once across all repos using our CLA. | ||
|
|
||
| This project has adopted the | ||
| [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, | ||
| see the Code of Conduct FAQ or contact opencode@microsoft.com with any | ||
| additional questions or comments. | ||
|
|
||
| <!-- LINKS --> | ||
| [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ | ||
| [authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token | ||
| [azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials | ||
| [azure_identity_pip]: https://pypi.org/project/azure-identity/ | ||
| [default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential | ||
| [pip]: https://pypi.org/project/pip/ | ||
| [azure_sub]: https://azure.microsoft.com/free/ | ||
11 changes: 11 additions & 0 deletions
11
sdk/deviceregistry/azure-iot-deviceregistrysoftwareupdate/_metadata.json
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "apiVersion": "2026-11-02-preview", | ||
| "apiVersions": { | ||
| "DeviceRegistrySoftwareUpdateClient": "2026-11-02-preview" | ||
| }, | ||
| "commit": "be4f14d4492f9f60eb6cabf3a93cce8a7cef803c", | ||
| "repository_url": "https://github.com/Azure/azure-rest-api-specs", | ||
| "typespec_src": "specification/deviceupdate/data-plane/sudeviceregistry", | ||
| "emitterVersion": "0.63.5", | ||
| "httpClientPythonVersion": "^0.36.0" | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.