forked from Azure/azure-sdk-for-python
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 32235 in Azure/azure-rest-api-specs
Merge 8087377626320cfd8c5ae1eb292ab2506fa5383c into 3a17b429e962d7a1a01c3c8fcdded8c8a2364196
- Loading branch information
SDKAuto
committed
Jan 22, 2025
1 parent
523fe37
commit 51f1a8c
Showing
63 changed files
with
3,692 additions
and
1,322 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,28 +1,61 @@ | ||
# Microsoft Azure SDK for Python | ||
|
||
This is the Microsoft Azure Advisor Client Library. | ||
This package has been tested with Python 3.7+. | ||
This package has been tested with Python 3.8+. | ||
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). | ||
|
||
## _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_ | ||
|
||
# Usage | ||
## Getting started | ||
|
||
### Prerequisites | ||
|
||
To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt) | ||
|
||
For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/advisor) | ||
Code samples for this package can be found at [Advisor](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com. | ||
Additional code samples for different Azure services are available at [Samples Repo](https://github.com/Azure-Samples/azure-samples-python-management/tree/main/samples/advisor) | ||
- Python 3.8+ is required to use this package. | ||
- [Azure subscription](https://azure.microsoft.com/free/) | ||
|
||
### Install the package | ||
|
||
# Provide Feedback | ||
```bash | ||
pip install azure-mgmt-advisor | ||
pip install azure-identity | ||
``` | ||
|
||
### Authentication | ||
|
||
By default, [Azure Active Directory](https://aka.ms/awps/aad) 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: | ||
|
||
```python | ||
from azure.identity import DefaultAzureCredential | ||
from azure.mgmt.advisor import AdvisorManagementClient | ||
import os | ||
|
||
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID") | ||
client = AdvisorManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id) | ||
``` | ||
|
||
## Examples | ||
|
||
Code samples for this package can be found at: | ||
- [Search Advisor](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com | ||
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples) | ||
|
||
|
||
## Troubleshooting | ||
|
||
## Next steps | ||
|
||
## Provide Feedback | ||
|
||
If you encounter any bugs or have suggestions, please file an issue in the | ||
[Issues](https://github.com/Azure/azure-sdk-for-python/issues) | ||
section of the project. | ||
|
||
|
||
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-advisor%2FREADME.png) |
This file contains 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 |
---|---|---|
@@ -1,11 +1,11 @@ | ||
{ | ||
"commit": "e82a24def11ffc98cc263884f9f1742c99f2df5e", | ||
"commit": "8a68cd85423642b67abbc034353e5d487d3f7bd9", | ||
"repository_url": "https://github.com/Azure/azure-rest-api-specs", | ||
"autorest": "3.9.2", | ||
"autorest": "3.10.2", | ||
"use": [ | ||
"@autorest/python@6.2.1", | ||
"@autorest/modelerfour@4.24.3" | ||
"@autorest/python@6.27.4", | ||
"@autorest/modelerfour@4.27.0" | ||
], | ||
"autorest_command": "autorest specification/advisor/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/home/vsts/work/1/azure-sdk-for-python/sdk --tag=package-2020-01 --use=@autorest/python@6.2.1 --use=@autorest/modelerfour@4.24.3 --version=3.9.2 --version-tolerant=False", | ||
"autorest_command": "autorest specification/advisor/resource-manager/readme.md --generate-sample=True --generate-test=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/python@6.27.4 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False", | ||
"readme": "specification/advisor/resource-manager/readme.md" | ||
} |
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.