Skip to content

Commit 801afb4

Browse files
author
SDKAuto
committed
CodeGen from PR 33107 in Azure/azure-rest-api-specs
Merge 37fade8eac2d3984082867649ec0d1414404ceee into 911dc10b0c10dc26cc4dc9dbc476731e16317bb9
1 parent e3a5c9d commit 801afb4

File tree

85 files changed

+7639
-1407
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+7639
-1407
lines changed
Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,61 @@
11
# Microsoft Azure SDK for Python
22

33
This is the Microsoft Azure Advisor Client Library.
4-
This package has been tested with Python 3.7+.
4+
This package has been tested with Python 3.8+.
55
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
66

77
## _Disclaimer_
88

99
_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_
1010

11-
# Usage
11+
## Getting started
1212

13+
### Prerequisites
1314

14-
To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt)
15-
16-
For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/advisor)
17-
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.
18-
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)
15+
- Python 3.8+ is required to use this package.
16+
- [Azure subscription](https://azure.microsoft.com/free/)
1917

18+
### Install the package
2019

21-
# Provide Feedback
20+
```bash
21+
pip install azure-mgmt-advisor
22+
pip install azure-identity
23+
```
2224

23-
If you encounter any bugs or have suggestions, please file an issue in the
24-
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
25-
section of the project.
25+
### Authentication
26+
27+
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.
28+
29+
- `AZURE_CLIENT_ID` for Azure client ID.
30+
- `AZURE_TENANT_ID` for Azure tenant ID.
31+
- `AZURE_CLIENT_SECRET` for Azure client secret.
32+
33+
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
34+
35+
With above configuration, client can be authenticated by following code:
36+
37+
```python
38+
from azure.identity import DefaultAzureCredential
39+
from azure.mgmt.advisor import AdvisorManagementClient
40+
import os
2641

42+
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
43+
client = AdvisorManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
44+
```
2745

46+
## Examples
2847

48+
Code samples for this package can be found at:
49+
- [Search Advisor](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
50+
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
51+
52+
53+
## Troubleshooting
54+
55+
## Next steps
56+
57+
## Provide Feedback
58+
59+
If you encounter any bugs or have suggestions, please file an issue in the
60+
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
61+
section of the project.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"commit": "e82a24def11ffc98cc263884f9f1742c99f2df5e",
2+
"commit": "4639e6af28debd0bc0ae945e7cf24c440e6d4bb4",
33
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4-
"autorest": "3.9.2",
4+
"autorest": "3.10.2",
55
"use": [
6-
"@autorest/python@6.2.1",
7-
"@autorest/modelerfour@4.24.3"
6+
"@autorest/python@6.27.4",
7+
"@autorest/modelerfour@4.27.0"
88
],
9-
"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",
9+
"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",
1010
"readme": "specification/advisor/resource-manager/readme.md"
1111
}

sdk/advisor/azure-mgmt-advisor/azure/mgmt/advisor/__init__.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,28 @@
55
# Code generated by Microsoft (R) AutoRest Code Generator.
66
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
77
# --------------------------------------------------------------------------
8+
# pylint: disable=wrong-import-position
89

9-
from ._advisor_management_client import AdvisorManagementClient
10+
from typing import TYPE_CHECKING
11+
12+
if TYPE_CHECKING:
13+
from ._patch import * # pylint: disable=unused-wildcard-import
14+
15+
from ._advisor_management_client import AdvisorManagementClient # type: ignore
1016
from ._version import VERSION
1117

1218
__version__ = VERSION
1319

1420
try:
1521
from ._patch import __all__ as _patch_all
16-
from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import
22+
from ._patch import *
1723
except ImportError:
1824
_patch_all = []
1925
from ._patch import patch_sdk as _patch_sdk
2026

2127
__all__ = [
2228
"AdvisorManagementClient",
2329
]
24-
__all__.extend([p for p in _patch_all if p not in __all__])
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
2531

2632
_patch_sdk()

sdk/advisor/azure-mgmt-advisor/azure/mgmt/advisor/_advisor_management_client.py

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,34 @@
88

99
from copy import deepcopy
1010
from typing import Any, TYPE_CHECKING
11+
from typing_extensions import Self
1112

13+
from azure.core.pipeline import policies
1214
from azure.core.rest import HttpRequest, HttpResponse
1315
from azure.mgmt.core import ARMPipelineClient
16+
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
1417

15-
from . import models
18+
from . import models as _models
1619
from ._configuration import AdvisorManagementClientConfiguration
1720
from ._serialization import Deserializer, Serializer
1821
from .operations import (
22+
AdvisorManagementClientOperationsMixin,
23+
AdvisorScoresOperations,
1924
ConfigurationsOperations,
2025
Operations,
2126
RecommendationMetadataOperations,
2227
RecommendationsOperations,
28+
ResiliencyReviewsOperations,
2329
SuppressionsOperations,
30+
TriageRecommendationsOperations,
31+
TriageResourcesOperations,
2432
)
2533

2634
if TYPE_CHECKING:
27-
# pylint: disable=unused-import,ungrouped-imports
2835
from azure.core.credentials import TokenCredential
2936

3037

31-
class AdvisorManagementClient: # pylint: disable=client-accepts-api-version-keyword
38+
class AdvisorManagementClient(AdvisorManagementClientOperationsMixin): # pylint: disable=too-many-instance-attributes
3239
"""REST APIs for Azure Advisor.
3340
3441
:ivar recommendation_metadata: RecommendationMetadataOperations operations
@@ -42,14 +49,22 @@ class AdvisorManagementClient: # pylint: disable=client-accepts-api-version-key
4249
:vartype operations: azure.mgmt.advisor.operations.Operations
4350
:ivar suppressions: SuppressionsOperations operations
4451
:vartype suppressions: azure.mgmt.advisor.operations.SuppressionsOperations
52+
:ivar advisor_scores: AdvisorScoresOperations operations
53+
:vartype advisor_scores: azure.mgmt.advisor.operations.AdvisorScoresOperations
54+
:ivar resiliency_reviews: ResiliencyReviewsOperations operations
55+
:vartype resiliency_reviews: azure.mgmt.advisor.operations.ResiliencyReviewsOperations
56+
:ivar triage_recommendations: TriageRecommendationsOperations operations
57+
:vartype triage_recommendations: azure.mgmt.advisor.operations.TriageRecommendationsOperations
58+
:ivar triage_resources: TriageResourcesOperations operations
59+
:vartype triage_resources: azure.mgmt.advisor.operations.TriageResourcesOperations
4560
:param credential: Credential needed for the client to connect to Azure. Required.
4661
:type credential: ~azure.core.credentials.TokenCredential
4762
:param subscription_id: The Azure subscription ID. Required.
4863
:type subscription_id: str
4964
:param base_url: Service URL. Default value is "https://management.azure.com".
5065
:type base_url: str
51-
:keyword api_version: Api Version. Default value is "2020-01-01". Note that overriding this
52-
default value may result in unsupported behavior.
66+
:keyword api_version: Api Version. Default value is "2024-11-18-preview". Note that overriding
67+
this default value may result in unsupported behavior.
5368
:paramtype api_version: str
5469
"""
5570

@@ -63,9 +78,27 @@ def __init__(
6378
self._config = AdvisorManagementClientConfiguration(
6479
credential=credential, subscription_id=subscription_id, **kwargs
6580
)
66-
self._client = ARMPipelineClient(base_url=base_url, config=self._config, **kwargs)
67-
68-
client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
81+
_policies = kwargs.pop("policies", None)
82+
if _policies is None:
83+
_policies = [
84+
policies.RequestIdPolicy(**kwargs),
85+
self._config.headers_policy,
86+
self._config.user_agent_policy,
87+
self._config.proxy_policy,
88+
policies.ContentDecodePolicy(**kwargs),
89+
ARMAutoResourceProviderRegistrationPolicy(),
90+
self._config.redirect_policy,
91+
self._config.retry_policy,
92+
self._config.authentication_policy,
93+
self._config.custom_hook_policy,
94+
self._config.logging_policy,
95+
policies.DistributedTracingPolicy(**kwargs),
96+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
97+
self._config.http_logging_policy,
98+
]
99+
self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, policies=_policies, **kwargs)
100+
101+
client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)}
69102
self._serialize = Serializer(client_models)
70103
self._deserialize = Deserializer(client_models)
71104
self._serialize.client_side_validation = False
@@ -76,8 +109,18 @@ def __init__(
76109
self.recommendations = RecommendationsOperations(self._client, self._config, self._serialize, self._deserialize)
77110
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
78111
self.suppressions = SuppressionsOperations(self._client, self._config, self._serialize, self._deserialize)
112+
self.advisor_scores = AdvisorScoresOperations(self._client, self._config, self._serialize, self._deserialize)
113+
self.resiliency_reviews = ResiliencyReviewsOperations(
114+
self._client, self._config, self._serialize, self._deserialize
115+
)
116+
self.triage_recommendations = TriageRecommendationsOperations(
117+
self._client, self._config, self._serialize, self._deserialize
118+
)
119+
self.triage_resources = TriageResourcesOperations(
120+
self._client, self._config, self._serialize, self._deserialize
121+
)
79122

80-
def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
123+
def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
81124
"""Runs the network request through the client's chained policies.
82125
83126
>>> from azure.core.rest import HttpRequest
@@ -97,17 +140,14 @@ def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
97140

98141
request_copy = deepcopy(request)
99142
request_copy.url = self._client.format_url(request_copy.url)
100-
return self._client.send_request(request_copy, **kwargs)
143+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
101144

102-
def close(self):
103-
# type: () -> None
145+
def close(self) -> None:
104146
self._client.close()
105147

106-
def __enter__(self):
107-
# type: () -> AdvisorManagementClient
148+
def __enter__(self) -> Self:
108149
self._client.__enter__()
109150
return self
110151

111-
def __exit__(self, *exc_details):
112-
# type: (Any) -> None
152+
def __exit__(self, *exc_details: Any) -> None:
113153
self._client.__exit__(*exc_details)

sdk/advisor/azure-mgmt-advisor/azure/mgmt/advisor/_configuration.py

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,18 @@
66
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
77
# --------------------------------------------------------------------------
88

9-
import sys
109
from typing import Any, TYPE_CHECKING
1110

12-
from azure.core.configuration import Configuration
1311
from azure.core.pipeline import policies
1412
from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy
1513

1614
from ._version import VERSION
1715

18-
if sys.version_info >= (3, 8):
19-
from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports
20-
else:
21-
from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports
22-
2316
if TYPE_CHECKING:
24-
# pylint: disable=unused-import,ungrouped-imports
2517
from azure.core.credentials import TokenCredential
2618

2719

28-
class AdvisorManagementClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes
20+
class AdvisorManagementClientConfiguration: # pylint: disable=too-many-instance-attributes
2921
"""Configuration for AdvisorManagementClient.
3022
3123
Note that all parameters used to create this instance are saved as instance
@@ -35,14 +27,13 @@ class AdvisorManagementClientConfiguration(Configuration): # pylint: disable=to
3527
:type credential: ~azure.core.credentials.TokenCredential
3628
:param subscription_id: The Azure subscription ID. Required.
3729
:type subscription_id: str
38-
:keyword api_version: Api Version. Default value is "2020-01-01". Note that overriding this
39-
default value may result in unsupported behavior.
30+
:keyword api_version: Api Version. Default value is "2024-11-18-preview". Note that overriding
31+
this default value may result in unsupported behavior.
4032
:paramtype api_version: str
4133
"""
4234

4335
def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs: Any) -> None:
44-
super(AdvisorManagementClientConfiguration, self).__init__(**kwargs)
45-
api_version = kwargs.pop("api_version", "2020-01-01") # type: Literal["2020-01-01"]
36+
api_version: str = kwargs.pop("api_version", "2024-11-18-preview")
4637

4738
if credential is None:
4839
raise ValueError("Parameter 'credential' must not be None.")
@@ -54,20 +45,18 @@ def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs
5445
self.api_version = api_version
5546
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
5647
kwargs.setdefault("sdk_moniker", "mgmt-advisor/{}".format(VERSION))
48+
self.polling_interval = kwargs.get("polling_interval", 30)
5749
self._configure(**kwargs)
5850

59-
def _configure(
60-
self, **kwargs # type: Any
61-
):
62-
# type: (...) -> None
51+
def _configure(self, **kwargs: Any) -> None:
6352
self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
6453
self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
6554
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
6655
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
6756
self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs)
68-
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
6957
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
7058
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
59+
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
7160
self.authentication_policy = kwargs.get("authentication_policy")
7261
if self.credential and not self.authentication_policy:
7362
self.authentication_policy = ARMChallengeAuthenticationPolicy(

0 commit comments

Comments
 (0)