Skip to content

Commit f189c8b

Browse files
azure-sdkChenxiJiang333liangchenmicrosoft
authored
[AutoRelease] t2-carbonoptimization-2025-04-22-36001(can only be merged by SDK owner) (#40641)
* code and test * update-testcase * Update release date to 2025-04-29 in CHANGELOG.md --------- Co-authored-by: azure-sdk <PythonSdkPipelines> Co-authored-by: ChenxiJiang333 <[email protected]> Co-authored-by: liangchenmicrosoft <[email protected]>
1 parent 5958ede commit f189c8b

File tree

68 files changed

+8497
-0
lines changed

Some content is hidden

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

68 files changed

+8497
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Release History
2+
3+
## 1.0.0b1 (2025-04-29)
4+
5+
### Other Changes
6+
7+
- Initial version
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
include _meta.json
2+
recursive-include tests *.py *.json
3+
recursive-include samples *.py *.md
4+
include *.md
5+
include azure/__init__.py
6+
include azure/mgmt/__init__.py
7+
include LICENSE
8+
include azure/mgmt/carbonoptimization/py.typed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Microsoft Azure SDK for Python
2+
3+
This is the Microsoft Azure Carbonoptimization Management Client Library.
4+
This package has been tested with Python 3.9+.
5+
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
6+
7+
## _Disclaimer_
8+
9+
_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_
10+
11+
## Getting started
12+
13+
### Prerequisites
14+
15+
- Python 3.9+ is required to use this package.
16+
- [Azure subscription](https://azure.microsoft.com/free/)
17+
18+
### Install the package
19+
20+
```bash
21+
pip install azure-mgmt-carbonoptimization
22+
pip install azure-identity
23+
```
24+
25+
### Authentication
26+
27+
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the 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.carbonoptimization import CarbonOptimizationMgmtClient
40+
import os
41+
42+
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
43+
client = CarbonOptimizationMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
44+
```
45+
46+
## Examples
47+
48+
Code samples for this package can be found at:
49+
- [Search Carbonoptimization Management](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: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "908f30f83295f8afe862310153344468510e3b88",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/carbon/Carbon.Management",
5+
"@azure-tools/typespec-python": "0.43.0"
6+
}
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"CrossLanguagePackageId": "Microsoft.Carbon",
3+
"CrossLanguageDefinitionId": {
4+
"azure.mgmt.carbonoptimization.models.CarbonEmissionData": "Microsoft.Carbon.CarbonEmissionData",
5+
"azure.mgmt.carbonoptimization.models.CarbonEmissionDataAvailableDateRange": "Microsoft.Carbon.CarbonEmissionDataAvailableDateRange",
6+
"azure.mgmt.carbonoptimization.models.CarbonEmissionDataListResult": "Microsoft.Carbon.CarbonEmissionDataListResult",
7+
"azure.mgmt.carbonoptimization.models.CarbonEmissionItemDetailData": "Microsoft.Carbon.CarbonEmissionItemDetailData",
8+
"azure.mgmt.carbonoptimization.models.CarbonEmissionMonthlySummaryData": "Microsoft.Carbon.CarbonEmissionMonthlySummaryData",
9+
"azure.mgmt.carbonoptimization.models.CarbonEmissionOverallSummaryData": "Microsoft.Carbon.CarbonEmissionOverallSummaryData",
10+
"azure.mgmt.carbonoptimization.models.CarbonEmissionTopItemMonthlySummaryData": "Microsoft.Carbon.CarbonEmissionTopItemMonthlySummaryData",
11+
"azure.mgmt.carbonoptimization.models.CarbonEmissionTopItemsSummaryData": "Microsoft.Carbon.CarbonEmissionTopItemsSummaryData",
12+
"azure.mgmt.carbonoptimization.models.DateRange": "Microsoft.Carbon.DateRange",
13+
"azure.mgmt.carbonoptimization.models.ErrorAdditionalInfo": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo",
14+
"azure.mgmt.carbonoptimization.models.ErrorDetail": "Azure.ResourceManager.CommonTypes.ErrorDetail",
15+
"azure.mgmt.carbonoptimization.models.ErrorResponse": "Azure.ResourceManager.CommonTypes.ErrorResponse",
16+
"azure.mgmt.carbonoptimization.models.QueryFilter": "Microsoft.Carbon.QueryFilter",
17+
"azure.mgmt.carbonoptimization.models.ItemDetailsQueryFilter": "Microsoft.Carbon.ItemDetailsQueryFilter",
18+
"azure.mgmt.carbonoptimization.models.MonthlySummaryReportQueryFilter": "Microsoft.Carbon.MonthlySummaryReportQueryFilter",
19+
"azure.mgmt.carbonoptimization.models.Operation": "Azure.ResourceManager.CommonTypes.Operation",
20+
"azure.mgmt.carbonoptimization.models.OperationDisplay": "Azure.ResourceManager.CommonTypes.OperationDisplay",
21+
"azure.mgmt.carbonoptimization.models.OverallSummaryReportQueryFilter": "Microsoft.Carbon.OverallSummaryReportQueryFilter",
22+
"azure.mgmt.carbonoptimization.models.ResourceCarbonEmissionItemDetailData": "Microsoft.Carbon.ResourceCarbonEmissionItemDetailData",
23+
"azure.mgmt.carbonoptimization.models.ResourceCarbonEmissionTopItemMonthlySummaryData": "Microsoft.Carbon.ResourceCarbonEmissionTopItemMonthlySummaryData",
24+
"azure.mgmt.carbonoptimization.models.ResourceCarbonEmissionTopItemsSummaryData": "Microsoft.Carbon.ResourceCarbonEmissionTopItemsSummaryData",
25+
"azure.mgmt.carbonoptimization.models.ResourceGroupCarbonEmissionItemDetailData": "Microsoft.Carbon.ResourceGroupCarbonEmissionItemDetailData",
26+
"azure.mgmt.carbonoptimization.models.ResourceGroupCarbonEmissionTopItemMonthlySummaryData": "Microsoft.Carbon.ResourceGroupCarbonEmissionTopItemMonthlySummaryData",
27+
"azure.mgmt.carbonoptimization.models.ResourceGroupCarbonEmissionTopItemsSummaryData": "Microsoft.Carbon.ResourceGroupCarbonEmissionTopItemsSummaryData",
28+
"azure.mgmt.carbonoptimization.models.SubscriptionAccessDecision": "Microsoft.Carbon.SubscriptionAccessDecision",
29+
"azure.mgmt.carbonoptimization.models.TopItemsMonthlySummaryReportQueryFilter": "Microsoft.Carbon.TopItemsMonthlySummaryReportQueryFilter",
30+
"azure.mgmt.carbonoptimization.models.TopItemsSummaryReportQueryFilter": "Microsoft.Carbon.TopItemsSummaryReportQueryFilter",
31+
"azure.mgmt.carbonoptimization.models.Origin": "Azure.ResourceManager.CommonTypes.Origin",
32+
"azure.mgmt.carbonoptimization.models.ActionType": "Azure.ResourceManager.CommonTypes.ActionType",
33+
"azure.mgmt.carbonoptimization.models.ResponseDataTypeEnum": "Microsoft.Carbon.ResponseDataTypeEnum",
34+
"azure.mgmt.carbonoptimization.models.CategoryTypeEnum": "Microsoft.Carbon.CategoryTypeEnum",
35+
"azure.mgmt.carbonoptimization.models.AccessDecisionEnum": "Microsoft.Carbon.AccessDecisionEnum",
36+
"azure.mgmt.carbonoptimization.models.ReportTypeEnum": "Microsoft.Carbon.ReportTypeEnum",
37+
"azure.mgmt.carbonoptimization.models.EmissionScopeEnum": "Microsoft.Carbon.EmissionScopeEnum",
38+
"azure.mgmt.carbonoptimization.models.OrderByColumnEnum": "Microsoft.Carbon.OrderByColumnEnum",
39+
"azure.mgmt.carbonoptimization.models.SortDirectionEnum": "Microsoft.Carbon.SortDirectionEnum",
40+
"azure.mgmt.carbonoptimization.CarbonOptimizationMgmtClient.operations.list": "Azure.ResourceManager.Operations.list",
41+
"azure.mgmt.carbonoptimization.CarbonOptimizationMgmtClient.carbon_service.query_carbon_emission_reports": "Microsoft.Carbon.CarbonService.queryCarbonEmissionReports",
42+
"azure.mgmt.carbonoptimization.CarbonOptimizationMgmtClient.carbon_service.query_carbon_emission_data_available_date_range": "Microsoft.Carbon.CarbonService.queryCarbonEmissionDataAvailableDateRange"
43+
}
44+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
# pylint: disable=wrong-import-position
9+
10+
from typing import TYPE_CHECKING
11+
12+
if TYPE_CHECKING:
13+
from ._patch import * # pylint: disable=unused-wildcard-import
14+
15+
from ._client import CarbonOptimizationMgmtClient # type: ignore
16+
from ._version import VERSION
17+
18+
__version__ = VERSION
19+
20+
try:
21+
from ._patch import __all__ as _patch_all
22+
from ._patch import *
23+
except ImportError:
24+
_patch_all = []
25+
from ._patch import patch_sdk as _patch_sdk
26+
27+
__all__ = [
28+
"CarbonOptimizationMgmtClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from copy import deepcopy
10+
from typing import Any, Optional, TYPE_CHECKING, cast
11+
from typing_extensions import Self
12+
13+
from azure.core.pipeline import policies
14+
from azure.core.rest import HttpRequest, HttpResponse
15+
from azure.core.settings import settings
16+
from azure.mgmt.core import ARMPipelineClient
17+
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
18+
from azure.mgmt.core.tools import get_arm_endpoints
19+
20+
from ._configuration import CarbonOptimizationMgmtClientConfiguration
21+
from ._serialization import Deserializer, Serializer
22+
from .operations import CarbonServiceOperations, Operations
23+
24+
if TYPE_CHECKING:
25+
from azure.core.credentials import TokenCredential
26+
27+
28+
class CarbonOptimizationMgmtClient:
29+
"""Carbon Report Resource Provider query API.
30+
31+
:ivar operations: Operations operations
32+
:vartype operations: azure.mgmt.carbonoptimization.operations.Operations
33+
:ivar carbon_service: CarbonServiceOperations operations
34+
:vartype carbon_service: azure.mgmt.carbonoptimization.operations.CarbonServiceOperations
35+
:param credential: Credential used to authenticate requests to the service. Required.
36+
:type credential: ~azure.core.credentials.TokenCredential
37+
:param base_url: Service host. Default value is None.
38+
:type base_url: str
39+
:keyword api_version: The API version to use for this operation. Default value is "2025-04-01".
40+
Note that overriding this default value may result in unsupported behavior.
41+
:paramtype api_version: str
42+
"""
43+
44+
def __init__(self, credential: "TokenCredential", base_url: Optional[str] = None, **kwargs: Any) -> None:
45+
_endpoint = "{endpoint}"
46+
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
47+
_endpoints = get_arm_endpoints(_cloud)
48+
if not base_url:
49+
base_url = _endpoints["resource_manager"]
50+
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
51+
self._config = CarbonOptimizationMgmtClientConfiguration(
52+
credential=credential, base_url=cast(str, base_url), credential_scopes=credential_scopes, **kwargs
53+
)
54+
55+
_policies = kwargs.pop("policies", None)
56+
if _policies is None:
57+
_policies = [
58+
policies.RequestIdPolicy(**kwargs),
59+
self._config.headers_policy,
60+
self._config.user_agent_policy,
61+
self._config.proxy_policy,
62+
policies.ContentDecodePolicy(**kwargs),
63+
ARMAutoResourceProviderRegistrationPolicy(),
64+
self._config.redirect_policy,
65+
self._config.retry_policy,
66+
self._config.authentication_policy,
67+
self._config.custom_hook_policy,
68+
self._config.logging_policy,
69+
policies.DistributedTracingPolicy(**kwargs),
70+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
71+
self._config.http_logging_policy,
72+
]
73+
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, _endpoint), policies=_policies, **kwargs)
74+
75+
self._serialize = Serializer()
76+
self._deserialize = Deserializer()
77+
self._serialize.client_side_validation = False
78+
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
79+
self.carbon_service = CarbonServiceOperations(self._client, self._config, self._serialize, self._deserialize)
80+
81+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
82+
"""Runs the network request through the client's chained policies.
83+
84+
>>> from azure.core.rest import HttpRequest
85+
>>> request = HttpRequest("GET", "https://www.example.org/")
86+
<HttpRequest [GET], url: 'https://www.example.org/'>
87+
>>> response = client.send_request(request)
88+
<HttpResponse: 200 OK>
89+
90+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
91+
92+
:param request: The network request you want to make. Required.
93+
:type request: ~azure.core.rest.HttpRequest
94+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
95+
:return: The response of your network call. Does not do error handling on your response.
96+
:rtype: ~azure.core.rest.HttpResponse
97+
"""
98+
99+
request_copy = deepcopy(request)
100+
path_format_arguments = {
101+
"endpoint": self._serialize.url("self._config.base_url", self._config.base_url, "str", skip_quote=True),
102+
}
103+
104+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
105+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
106+
107+
def close(self) -> None:
108+
self._client.close()
109+
110+
def __enter__(self) -> Self:
111+
self._client.__enter__()
112+
return self
113+
114+
def __exit__(self, *exc_details: Any) -> None:
115+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)