{"id":4452,"library":"azure-mgmt-databoxedge","title":"Microsoft Azure Data Box Edge Management Client Library for Python","description":"This package provides the Microsoft Azure Data Box Edge Management Client Library for Python, enabling users to programmatically manage Azure Data Box Edge resources. It supports Python 3.8+ and is part of the actively maintained Azure SDK for Python.","status":"active","version":"2.0.0","language":"en","source_language":"en","source_url":"https://github.com/Azure/azure-sdk-for-python","tags":["azure","management","databoxedge","cloud","microsoft"],"install":[{"cmd":"pip install azure-mgmt-databoxedge azure-identity","lang":"bash","label":"Install with pip"}],"dependencies":[{"reason":"Required for Azure Active Directory token authentication.","package":"azure-identity","optional":false}],"imports":[{"symbol":"DataBoxEdgeManagementClient","correct":"from azure.mgmt.databoxedge import DataBoxEdgeManagementClient"},{"note":"The credential system was completely revamped. Use azure-identity classes instead of old msrestazure or azure.common.credentials patterns.","wrong":"from msrestazure.azure_active_directory import AzureServicePrincipalCredentials","symbol":"DefaultAzureCredential","correct":"from azure.identity import DefaultAzureCredential"}],"quickstart":{"code":"import os\nfrom azure.identity import DefaultAzureCredential\nfrom azure.mgmt.databoxedge import DataBoxEdgeManagementClient\n\n# Set environment variables for authentication:\n# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, AZURE_SUBSCRIPTION_ID\n\nsubscription_id = os.environ.get('AZURE_SUBSCRIPTION_ID', '')\nif not subscription_id:\n    raise ValueError(\"AZURE_SUBSCRIPTION_ID environment variable is not set.\")\n\n# Authenticate using DefaultAzureCredential\ncredential = DefaultAzureCredential()\n\n# Create a client\nclient = DataBoxEdgeManagementClient(credential, subscription_id)\n\n# Example: List Data Box Edge devices (this is a placeholder for actual operations)\n# Replace with actual resource group and device names as needed.\n# print(client.devices.list_by_subscription())\nprint(\"Azure Data Box Edge client initialized. You can now perform operations.\")","lang":"python","description":"Initializes the DataBoxEdgeManagementClient using `DefaultAzureCredential`. Ensure environment variables `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`, and `AZURE_SUBSCRIPTION_ID` are set for authentication."},"warnings":[{"fix":"Migrate to `azure-identity` classes (e.g., `DefaultAzureCredential`) and use the `credential` keyword argument.","message":"The credential system has been completely revamped in version 2.0.0. `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported. The `credentials` parameter has been renamed to `credential`.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Adjust code to use `begin_` prefixed methods for long-running operations and handle `azure.core.exceptions.HttpResponseError` for general API errors.","message":"Operations that previously returned `msrest.polling.LROPoller` now return `azure.core.polling.LROPoller` and are prefixed with `begin_`. The exception hierarchy has also been simplified; `CloudError` has been removed and most exceptions are now `azure.core.exceptions.HttpResponseError`.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"If encountering issues with specific API versions, consider pinning the `azure-mgmt-databoxedge` package to the previous major version (e.g., `1.0.0`) or update your code to use the latest API version.","message":"Version 2.0.0 removed subfolders of some unused API versions to reduce package size. If your application relies on a specific, non-latest API version that was removed, it may break.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Ensure `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` (or other credential types) and `AZURE_SUBSCRIPTION_ID` are set in your environment.","message":"For `DefaultAzureCredential` to work out-of-the-box, several environment variables are typically required for Azure Active Directory authentication (e.g., service principal details).","severity":"gotcha","affected_versions":"all"},{"fix":"Ensure your development and deployment environments are running Python 3.8 or a later compatible version.","message":"The package requires Python 3.8 or newer. Using older Python versions will result in installation or runtime errors.","severity":"gotcha","affected_versions":"<3.8"}],"env_vars":null,"last_verified":"2026-04-12T00:00:00.000Z","next_check":"2026-07-11T00:00:00.000Z"}