|
| 1 | +--- |
| 2 | +title: |
| 3 | +keywords: Azure, python, SDK, API, azure-mgmt-cognitiveservices, cognitiveservices |
| 4 | +ms.date: 05/15/2025 |
| 5 | +ms.topic: reference |
| 6 | +ms.devlang: python |
| 7 | +ms.service: cognitiveservices |
| 8 | +--- |
| 9 | +# Microsoft Azure SDK for Python |
| 10 | + |
| 11 | +This is the Microsoft Azure Cognitive Services Management Client Library. |
| 12 | +This package has been tested with Python 3.9+. |
| 13 | +For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). |
| 14 | + |
| 15 | +## _Disclaimer_ |
| 16 | + |
| 17 | +_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_ |
| 18 | + |
| 19 | +## Getting started |
| 20 | + |
| 21 | +### Prerequisites |
| 22 | + |
| 23 | +- Python 3.9+ is required to use this package. |
| 24 | +- [Azure subscription](https://azure.microsoft.com/free/) |
| 25 | + |
| 26 | +### Install the package |
| 27 | + |
| 28 | +```bash |
| 29 | +pip install azure-mgmt-cognitiveservices |
| 30 | +pip install azure-identity |
| 31 | +``` |
| 32 | + |
| 33 | +### Authentication |
| 34 | + |
| 35 | +By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables. |
| 36 | + |
| 37 | +- `AZURE_CLIENT_ID` for Azure client ID. |
| 38 | +- `AZURE_TENANT_ID` for Azure tenant ID. |
| 39 | +- `AZURE_CLIENT_SECRET` for Azure client secret. |
| 40 | + |
| 41 | +In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`. |
| 42 | + |
| 43 | +With above configuration, client can be authenticated by following code: |
| 44 | + |
| 45 | +```python |
| 46 | +from azure.identity import DefaultAzureCredential |
| 47 | +from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient |
| 48 | +import os |
| 49 | + |
| 50 | +sub_id = os.getenv("AZURE_SUBSCRIPTION_ID") |
| 51 | +client = CognitiveServicesManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id) |
| 52 | +``` |
| 53 | + |
| 54 | +## Examples |
| 55 | + |
| 56 | +Code samples for this package can be found at: |
| 57 | +- [Search Cognitive Services Management](/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com |
| 58 | +- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples) |
| 59 | + |
| 60 | + |
| 61 | +## Troubleshooting |
| 62 | + |
| 63 | +## Next steps |
| 64 | + |
| 65 | +## Provide Feedback |
| 66 | + |
| 67 | +If you encounter any bugs or have suggestions, please file an issue in the |
| 68 | +[Issues](https://github.com/Azure/azure-sdk-for-python/issues) |
| 69 | +section of the project. |
| 70 | + |
0 commit comments