Skip to content

Commit 2785b7d

Browse files
azure-sdkChenxiJiang333smichtch
authored
[AutoRelease] t2-onlineexperimentation-2025-04-22-80414(can only be merged by SDK owner) (#40642)
* code and test * update-testcase * Update release date. * Update TypeSpec, regenerate code. --------- Co-authored-by: azure-sdk <PythonSdkPipelines> Co-authored-by: ChenxiJiang333 <[email protected]> Co-authored-by: smichtch <[email protected]>
1 parent e480f3c commit 2785b7d

File tree

55 files changed

+8382
-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.

55 files changed

+8382
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Release History
2+
3+
## 1.0.0b1 (2025-05-31)
4+
5+
### Other Changes
6+
7+
- Initial version
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.
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/onlineexperimentation/py.typed
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 Onlineexperimentation 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-onlineexperimentation
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.onlineexperimentation import OnlineExperimentationMgmtClient
40+
import os
41+
42+
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
43+
client = OnlineExperimentationMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
44+
```
45+
46+
## Examples
47+
48+
Code samples for this package can be found at:
49+
- [Search Onlineexperimentation 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.
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/onlineexperimentation/OnlineExperimentation.Management",
5+
"@azure-tools/typespec-python": "0.43.0"
6+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"CrossLanguagePackageId": "Microsoft.OnlineExperimentation",
3+
"CrossLanguageDefinitionId": {
4+
"azure.mgmt.onlineexperimentation.models.CustomerManagedKeyEncryption": "Microsoft.OnlineExperimentation.CustomerManagedKeyEncryption",
5+
"azure.mgmt.onlineexperimentation.models.ErrorAdditionalInfo": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo",
6+
"azure.mgmt.onlineexperimentation.models.ErrorDetail": "Azure.ResourceManager.CommonTypes.ErrorDetail",
7+
"azure.mgmt.onlineexperimentation.models.ErrorResponse": "Azure.ResourceManager.CommonTypes.ErrorResponse",
8+
"azure.mgmt.onlineexperimentation.models.KeyEncryptionKeyIdentity": "Microsoft.OnlineExperimentation.KeyEncryptionKeyIdentity",
9+
"azure.mgmt.onlineexperimentation.models.ManagedServiceIdentity": "Azure.ResourceManager.CommonTypes.ManagedServiceIdentity",
10+
"azure.mgmt.onlineexperimentation.models.OnlineExperimentationWorkspaceSku": "Microsoft.OnlineExperimentation.OnlineExperimentationWorkspaceSku",
11+
"azure.mgmt.onlineexperimentation.models.Resource": "Azure.ResourceManager.CommonTypes.Resource",
12+
"azure.mgmt.onlineexperimentation.models.TrackedResource": "Azure.ResourceManager.CommonTypes.TrackedResource",
13+
"azure.mgmt.onlineexperimentation.models.OnlineExperimentWorkspace": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspace",
14+
"azure.mgmt.onlineexperimentation.models.OnlineExperimentWorkspacePatch": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspacePatch",
15+
"azure.mgmt.onlineexperimentation.models.OnlineExperimentWorkspacePatchProperties": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspacePatch.properties.anonymous",
16+
"azure.mgmt.onlineexperimentation.models.OnlineExperimentWorkspaceProperties": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspaceProperties",
17+
"azure.mgmt.onlineexperimentation.models.Operation": "Azure.ResourceManager.CommonTypes.Operation",
18+
"azure.mgmt.onlineexperimentation.models.OperationDisplay": "Azure.ResourceManager.CommonTypes.OperationDisplay",
19+
"azure.mgmt.onlineexperimentation.models.ResourceEncryptionConfiguration": "Microsoft.OnlineExperimentation.ResourceEncryptionConfiguration",
20+
"azure.mgmt.onlineexperimentation.models.SystemData": "Azure.ResourceManager.CommonTypes.SystemData",
21+
"azure.mgmt.onlineexperimentation.models.UserAssignedIdentity": "Azure.ResourceManager.CommonTypes.UserAssignedIdentity",
22+
"azure.mgmt.onlineexperimentation.models.Origin": "Azure.ResourceManager.CommonTypes.Origin",
23+
"azure.mgmt.onlineexperimentation.models.ActionType": "Azure.ResourceManager.CommonTypes.ActionType",
24+
"azure.mgmt.onlineexperimentation.models.CreatedByType": "Azure.ResourceManager.CommonTypes.createdByType",
25+
"azure.mgmt.onlineexperimentation.models.ResourceProvisioningState": "Azure.ResourceManager.ResourceProvisioningState",
26+
"azure.mgmt.onlineexperimentation.models.KeyEncryptionKeyIdentityType": "Microsoft.OnlineExperimentation.KeyEncryptionKeyIdentityType",
27+
"azure.mgmt.onlineexperimentation.models.ManagedServiceIdentityType": "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType",
28+
"azure.mgmt.onlineexperimentation.models.OnlineExperimentationWorkspaceSkuName": "Microsoft.OnlineExperimentation.OnlineExperimentationWorkspaceSkuName",
29+
"azure.mgmt.onlineexperimentation.models.OnlineExperimentationWorkspaceSkuTier": "Microsoft.OnlineExperimentation.OnlineExperimentationWorkspaceSkuTier",
30+
"azure.mgmt.onlineexperimentation.OnlineExperimentationMgmtClient.operations.list": "Azure.ResourceManager.Operations.list",
31+
"azure.mgmt.onlineexperimentation.OnlineExperimentationMgmtClient.online_experiment_workspaces.get": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspaces.get",
32+
"azure.mgmt.onlineexperimentation.OnlineExperimentationMgmtClient.online_experiment_workspaces.begin_create_or_update": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspaces.createOrUpdate",
33+
"azure.mgmt.onlineexperimentation.OnlineExperimentationMgmtClient.online_experiment_workspaces.begin_update": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspaces.update",
34+
"azure.mgmt.onlineexperimentation.OnlineExperimentationMgmtClient.online_experiment_workspaces.begin_delete": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspaces.delete",
35+
"azure.mgmt.onlineexperimentation.OnlineExperimentationMgmtClient.online_experiment_workspaces.list_by_resource_group": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspaces.listByResourceGroup",
36+
"azure.mgmt.onlineexperimentation.OnlineExperimentationMgmtClient.online_experiment_workspaces.list_by_subscription": "Microsoft.OnlineExperimentation.OnlineExperimentWorkspaces.listBySubscription"
37+
}
38+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
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 OnlineExperimentationMgmtClient # 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+
"OnlineExperimentationMgmtClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
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 OnlineExperimentationMgmtClientConfiguration
21+
from ._serialization import Deserializer, Serializer
22+
from .operations import OnlineExperimentWorkspacesOperations, Operations
23+
24+
if TYPE_CHECKING:
25+
from azure.core.credentials import TokenCredential
26+
27+
28+
class OnlineExperimentationMgmtClient:
29+
"""Microsoft.OnlineExperimentation Resource Provider management API.
30+
31+
:ivar operations: Operations operations
32+
:vartype operations: azure.mgmt.onlineexperimentation.operations.Operations
33+
:ivar online_experiment_workspaces: OnlineExperimentWorkspacesOperations operations
34+
:vartype online_experiment_workspaces:
35+
azure.mgmt.onlineexperimentation.operations.OnlineExperimentWorkspacesOperations
36+
:param credential: Credential used to authenticate requests to the service. Required.
37+
:type credential: ~azure.core.credentials.TokenCredential
38+
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
39+
:type subscription_id: str
40+
:param base_url: Service host. Default value is None.
41+
:type base_url: str
42+
:keyword api_version: The API version to use for this operation. Default value is
43+
"2025-05-31-preview". Note that overriding this default value may result in unsupported
44+
behavior.
45+
:paramtype api_version: str
46+
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
47+
Retry-After header is present.
48+
"""
49+
50+
def __init__(
51+
self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any
52+
) -> None:
53+
_endpoint = "{endpoint}"
54+
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
55+
_endpoints = get_arm_endpoints(_cloud)
56+
if not base_url:
57+
base_url = _endpoints["resource_manager"]
58+
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
59+
self._config = OnlineExperimentationMgmtClientConfiguration(
60+
credential=credential,
61+
subscription_id=subscription_id,
62+
base_url=cast(str, base_url),
63+
credential_scopes=credential_scopes,
64+
**kwargs
65+
)
66+
67+
_policies = kwargs.pop("policies", None)
68+
if _policies is None:
69+
_policies = [
70+
policies.RequestIdPolicy(**kwargs),
71+
self._config.headers_policy,
72+
self._config.user_agent_policy,
73+
self._config.proxy_policy,
74+
policies.ContentDecodePolicy(**kwargs),
75+
ARMAutoResourceProviderRegistrationPolicy(),
76+
self._config.redirect_policy,
77+
self._config.retry_policy,
78+
self._config.authentication_policy,
79+
self._config.custom_hook_policy,
80+
self._config.logging_policy,
81+
policies.DistributedTracingPolicy(**kwargs),
82+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
83+
self._config.http_logging_policy,
84+
]
85+
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, _endpoint), policies=_policies, **kwargs)
86+
87+
self._serialize = Serializer()
88+
self._deserialize = Deserializer()
89+
self._serialize.client_side_validation = False
90+
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
91+
self.online_experiment_workspaces = OnlineExperimentWorkspacesOperations(
92+
self._client, self._config, self._serialize, self._deserialize
93+
)
94+
95+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
96+
"""Runs the network request through the client's chained policies.
97+
98+
>>> from azure.core.rest import HttpRequest
99+
>>> request = HttpRequest("GET", "https://www.example.org/")
100+
<HttpRequest [GET], url: 'https://www.example.org/'>
101+
>>> response = client.send_request(request)
102+
<HttpResponse: 200 OK>
103+
104+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
105+
106+
:param request: The network request you want to make. Required.
107+
:type request: ~azure.core.rest.HttpRequest
108+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
109+
:return: The response of your network call. Does not do error handling on your response.
110+
:rtype: ~azure.core.rest.HttpResponse
111+
"""
112+
113+
request_copy = deepcopy(request)
114+
path_format_arguments = {
115+
"endpoint": self._serialize.url("self._config.base_url", self._config.base_url, "str", skip_quote=True),
116+
}
117+
118+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
119+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
120+
121+
def close(self) -> None:
122+
self._client.close()
123+
124+
def __enter__(self) -> Self:
125+
self._client.__enter__()
126+
return self
127+
128+
def __exit__(self, *exc_details: Any) -> None:
129+
self._client.__exit__(*exc_details)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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 typing import Any, TYPE_CHECKING
10+
11+
from azure.core.pipeline import policies
12+
from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy
13+
14+
from ._version import VERSION
15+
16+
if TYPE_CHECKING:
17+
from azure.core.credentials import TokenCredential
18+
19+
20+
class OnlineExperimentationMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
21+
"""Configuration for OnlineExperimentationMgmtClient.
22+
23+
Note that all parameters used to create this instance are saved as instance
24+
attributes.
25+
26+
:param credential: Credential used to authenticate requests to the service. Required.
27+
:type credential: ~azure.core.credentials.TokenCredential
28+
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
29+
:type subscription_id: str
30+
:param base_url: Service host. Default value is "https://management.azure.com".
31+
:type base_url: str
32+
:keyword api_version: The API version to use for this operation. Default value is
33+
"2025-05-31-preview". Note that overriding this default value may result in unsupported
34+
behavior.
35+
:paramtype api_version: str
36+
"""
37+
38+
def __init__(
39+
self,
40+
credential: "TokenCredential",
41+
subscription_id: str,
42+
base_url: str = "https://management.azure.com",
43+
**kwargs: Any
44+
) -> None:
45+
api_version: str = kwargs.pop("api_version", "2025-05-31-preview")
46+
47+
if credential is None:
48+
raise ValueError("Parameter 'credential' must not be None.")
49+
if subscription_id is None:
50+
raise ValueError("Parameter 'subscription_id' must not be None.")
51+
52+
self.credential = credential
53+
self.subscription_id = subscription_id
54+
self.base_url = base_url
55+
self.api_version = api_version
56+
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
57+
kwargs.setdefault("sdk_moniker", "mgmt-onlineexperimentation/{}".format(VERSION))
58+
self.polling_interval = kwargs.get("polling_interval", 30)
59+
self._configure(**kwargs)
60+
61+
def _configure(self, **kwargs: Any) -> None:
62+
self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
63+
self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
64+
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
65+
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
66+
self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs)
67+
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
68+
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
69+
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
70+
self.authentication_policy = kwargs.get("authentication_policy")
71+
if self.credential and not self.authentication_policy:
72+
self.authentication_policy = ARMChallengeAuthenticationPolicy(
73+
self.credential, *self.credential_scopes, **kwargs
74+
)

0 commit comments

Comments
 (0)