Microsoft Azure SDK for Python

This is the Microsoft Azure Sphere Management Client Library. This package has been tested with Python 3.8+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

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

Getting started

Prerequisites

• Python 3.8+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-sphere
pip install azure-identity

Authentication

By default, Azure Active Directory token authentication depends on correct configure of following environment variables.

• AZURE_CLIENT_ID for Azure client ID.
• AZURE_TENANT_ID for Azure tenant ID.
• AZURE_CLIENT_SECRET for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, client can be authenticated by following code:

from azure.identity import DefaultAzureCredential
from azure.mgmt.sphere import AzureSphereMgmtClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = AzureSphereMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

Examples

Code samples for this package can be found at:

• Search Sphere Management on docs.microsoft.com
• Azure Python Mgmt SDK Samples Repo

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

1.0.0 (2024-03-26)

Features Added

• Added operation CatalogsOperations.begin_upload_image
• Model Catalog has a new parameter properties
• Model Certificate has a new parameter properties
• Model Deployment has a new parameter properties
• Model Device has a new parameter properties
• Model DeviceGroup has a new parameter properties
• Model DeviceGroupUpdate has a new parameter properties
• Model DeviceUpdate has a new parameter properties
• Model Image has a new parameter properties
• Model Product has a new parameter properties
• Model ProductUpdate has a new parameter properties

Breaking Changes

• Model Catalog no longer has parameter provisioning_state
• Model Certificate no longer has parameter certificate
• Model Certificate no longer has parameter expiry_utc
• Model Certificate no longer has parameter not_before_utc
• Model Certificate no longer has parameter provisioning_state
• Model Certificate no longer has parameter status
• Model Certificate no longer has parameter subject
• Model Certificate no longer has parameter thumbprint
• Model Deployment no longer has parameter deployed_images
• Model Deployment no longer has parameter deployment_date_utc
• Model Deployment no longer has parameter deployment_id
• Model Deployment no longer has parameter provisioning_state
• Model Device no longer has parameter chip_sku
• Model Device no longer has parameter device_id
• Model Device no longer has parameter last_available_os_version
• Model Device no longer has parameter last_installed_os_version
• Model Device no longer has parameter last_os_update_utc
• Model Device no longer has parameter last_update_request_utc
• Model Device no longer has parameter provisioning_state
• Model DeviceGroup no longer has parameter allow_crash_dumps_collection
• Model DeviceGroup no longer has parameter description
• Model DeviceGroup no longer has parameter has_deployment
• Model DeviceGroup no longer has parameter os_feed_type
• Model DeviceGroup no longer has parameter provisioning_state
• Model DeviceGroup no longer has parameter regional_data_boundary
• Model DeviceGroup no longer has parameter update_policy
• Model DeviceGroupUpdate no longer has parameter allow_crash_dumps_collection
• Model DeviceGroupUpdate no longer has parameter description
• Model DeviceGroupUpdate no longer has parameter os_feed_type
• Model DeviceGroupUpdate no longer has parameter regional_data_boundary
• Model DeviceGroupUpdate no longer has parameter update_policy
• Model DeviceUpdate no longer has parameter device_group_id
• Model Image no longer has parameter component_id
• Model Image no longer has parameter description
• Model Image no longer has parameter image
• Model Image no longer has parameter image_id
• Model Image no longer has parameter image_name
• Model Image no longer has parameter image_type
• Model Image no longer has parameter provisioning_state
• Model Image no longer has parameter regional_data_boundary
• Model Image no longer has parameter uri
• Model Product no longer has parameter description
• Model Product no longer has parameter provisioning_state
• Model ProductUpdate no longer has parameter description

1.0.0b1 (2023-07-21)

• Initial Release