Skip to content

Commit 1cee683

Browse files
azure-sdkmsyycCopilotChenxiJiang333
authored
[AutoRelease] t2-portalservicescopilot-2025-04-15-94466(can only be merged by SDK owner) (#40506)
* code and test * Update sdk/portalservices/azure-mgmt-portalservicescopilot/README.md Co-authored-by: Copilot <[email protected]> * update testcases * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: azure-sdk <PythonSdkPipelines> Co-authored-by: Yuchao Yan <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: ChenxiJiang333 <[email protected]> Co-authored-by: ChenxiJiang333 <[email protected]>
1 parent 3be08f1 commit 1cee683

Some content is hidden

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

49 files changed

+6345
-0
lines changed

‎sdk/portalservices/azure-mgmt-portalservicescopilot/CHANGELOG.md

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-23)
4+
5+
### Other Changes
6+
7+
- Initial version

‎sdk/portalservices/azure-mgmt-portalservicescopilot/LICENSE

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.

‎sdk/portalservices/azure-mgmt-portalservicescopilot/MANIFEST.in

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/portalservicescopilot/py.typed

‎sdk/portalservices/azure-mgmt-portalservicescopilot/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Microsoft Azure SDK for Python
2+
3+
This is the Microsoft Azure Portalservicescopilot Management Client Library.
4+
This package has been tested with Python 3.8+.
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.8+ 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-portalservicescopilot
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+
With the above configuration, the client can be authenticated using the following code:
34+
35+
```python
36+
from azure.identity import DefaultAzureCredential
37+
from azure.mgmt.portalservicescopilot import PortalServicesCopilotMgmtClient
38+
39+
client = PortalServicesCopilotMgmtClient(credential=DefaultAzureCredential())
40+
```
41+
42+
## Examples
43+
44+
Code samples for this package can be found at:
45+
- [Search Portalservicescopilot Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
46+
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
47+
48+
49+
## Troubleshooting
50+
51+
## Next steps
52+
53+
## Provide Feedback
54+
55+
If you encounter any bugs or have suggestions, please file an issue in the
56+
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
57+
section of the project.

‎sdk/portalservices/azure-mgmt-portalservicescopilot/_meta.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "5b4d360e915c96af135f02d4eefddb5ede18bc91",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/portalservices/CopilotSettings.Management",
5+
"@azure-tools/typespec-python": "0.42.2"
6+
}

‎sdk/portalservices/azure-mgmt-portalservicescopilot/apiview-properties.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"CrossLanguagePackageId": "Microsoft.PortalServices",
3+
"CrossLanguageDefinitionId": {
4+
"azure.mgmt.portalservicescopilot.models.CopilotSettingsProperties": "Microsoft.PortalServices.CopilotSettingsProperties",
5+
"azure.mgmt.portalservicescopilot.models.Resource": "Azure.ResourceManager.CommonTypes.Resource",
6+
"azure.mgmt.portalservicescopilot.models.ProxyResource": "Azure.ResourceManager.CommonTypes.ProxyResource",
7+
"azure.mgmt.portalservicescopilot.models.CopilotSettingsResource": "Microsoft.PortalServices.CopilotSettingsResource",
8+
"azure.mgmt.portalservicescopilot.models.CopilotSettingsResourceUpdate": "Azure.ResourceManager.Foundations.ResourceUpdateModel",
9+
"azure.mgmt.portalservicescopilot.models.CopilotSettingsResourceUpdateProperties": "Azure.ResourceManager.Foundations.ResourceUpdateModelProperties",
10+
"azure.mgmt.portalservicescopilot.models.ErrorAdditionalInfo": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo",
11+
"azure.mgmt.portalservicescopilot.models.ErrorDetail": "Azure.ResourceManager.CommonTypes.ErrorDetail",
12+
"azure.mgmt.portalservicescopilot.models.ErrorResponse": "Azure.ResourceManager.CommonTypes.ErrorResponse",
13+
"azure.mgmt.portalservicescopilot.models.Operation": "Azure.ResourceManager.CommonTypes.Operation",
14+
"azure.mgmt.portalservicescopilot.models.OperationDisplay": "Azure.ResourceManager.CommonTypes.OperationDisplay",
15+
"azure.mgmt.portalservicescopilot.models.SystemData": "Azure.ResourceManager.CommonTypes.SystemData",
16+
"azure.mgmt.portalservicescopilot.models.Origin": "Azure.ResourceManager.CommonTypes.Origin",
17+
"azure.mgmt.portalservicescopilot.models.ActionType": "Azure.ResourceManager.CommonTypes.ActionType",
18+
"azure.mgmt.portalservicescopilot.models.CreatedByType": "Azure.ResourceManager.CommonTypes.createdByType",
19+
"azure.mgmt.portalservicescopilot.models.ResourceProvisioningState": "Azure.ResourceManager.ResourceProvisioningState",
20+
"azure.mgmt.portalservicescopilot.PortalServicesCopilotMgmtClient.operations.list": "Azure.ResourceManager.Operations.list",
21+
"azure.mgmt.portalservicescopilot.PortalServicesCopilotMgmtClient.copilot_settings.get": "Microsoft.PortalServices.CopilotSettings.get",
22+
"azure.mgmt.portalservicescopilot.PortalServicesCopilotMgmtClient.copilot_settings.create_or_update": "Microsoft.PortalServices.CopilotSettings.createOrUpdate",
23+
"azure.mgmt.portalservicescopilot.PortalServicesCopilotMgmtClient.copilot_settings.update": "Microsoft.PortalServices.CopilotSettings.update",
24+
"azure.mgmt.portalservicescopilot.PortalServicesCopilotMgmtClient.copilot_settings.delete": "Microsoft.PortalServices.CopilotSettings.delete"
25+
}
26+
}

‎sdk/portalservices/azure-mgmt-portalservicescopilot/azure/__init__.py

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__)

‎sdk/portalservices/azure-mgmt-portalservicescopilot/azure/mgmt/__init__.py

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__)

‎sdk/portalservices/azure-mgmt-portalservicescopilot/azure/mgmt/portalservicescopilot/__init__.py

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 PortalServicesCopilotMgmtClient # 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+
"PortalServicesCopilotMgmtClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()

‎sdk/portalservices/azure-mgmt-portalservicescopilot/azure/mgmt/portalservicescopilot/_client.py

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
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, TYPE_CHECKING
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.mgmt.core import ARMPipelineClient
16+
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
17+
18+
from ._configuration import PortalServicesCopilotMgmtClientConfiguration
19+
from ._serialization import Deserializer, Serializer
20+
from .operations import CopilotSettingsOperations, Operations
21+
22+
if TYPE_CHECKING:
23+
from azure.core.credentials import TokenCredential
24+
25+
26+
class PortalServicesCopilotMgmtClient:
27+
"""Azure Portal Services API Reference.
28+
29+
:ivar operations: Operations operations
30+
:vartype operations: azure.mgmt.portalservicescopilot.operations.Operations
31+
:ivar copilot_settings: CopilotSettingsOperations operations
32+
:vartype copilot_settings:
33+
azure.mgmt.portalservicescopilot.operations.CopilotSettingsOperations
34+
:param credential: Credential used to authenticate requests to the service. Required.
35+
:type credential: ~azure.core.credentials.TokenCredential
36+
:param base_url: Service host. Default value is "https://management.azure.com".
37+
:type base_url: str
38+
:keyword api_version: The API version to use for this operation. Default value is
39+
"2024-04-01-preview". Note that overriding this default value may result in unsupported
40+
behavior.
41+
:paramtype api_version: str
42+
"""
43+
44+
def __init__(
45+
self, credential: "TokenCredential", base_url: str = "https://management.azure.com", **kwargs: Any
46+
) -> None:
47+
_endpoint = "{endpoint}"
48+
self._config = PortalServicesCopilotMgmtClientConfiguration(credential=credential, base_url=base_url, **kwargs)
49+
_policies = kwargs.pop("policies", None)
50+
if _policies is None:
51+
_policies = [
52+
policies.RequestIdPolicy(**kwargs),
53+
self._config.headers_policy,
54+
self._config.user_agent_policy,
55+
self._config.proxy_policy,
56+
policies.ContentDecodePolicy(**kwargs),
57+
ARMAutoResourceProviderRegistrationPolicy(),
58+
self._config.redirect_policy,
59+
self._config.retry_policy,
60+
self._config.authentication_policy,
61+
self._config.custom_hook_policy,
62+
self._config.logging_policy,
63+
policies.DistributedTracingPolicy(**kwargs),
64+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
65+
self._config.http_logging_policy,
66+
]
67+
self._client: ARMPipelineClient = ARMPipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
68+
69+
self._serialize = Serializer()
70+
self._deserialize = Deserializer()
71+
self._serialize.client_side_validation = False
72+
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
73+
self.copilot_settings = CopilotSettingsOperations(
74+
self._client, self._config, self._serialize, self._deserialize
75+
)
76+
77+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
78+
"""Runs the network request through the client's chained policies.
79+
80+
>>> from azure.core.rest import HttpRequest
81+
>>> request = HttpRequest("GET", "https://www.example.org/")
82+
<HttpRequest [GET], url: 'https://www.example.org/'>
83+
>>> response = client.send_request(request)
84+
<HttpResponse: 200 OK>
85+
86+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
87+
88+
:param request: The network request you want to make. Required.
89+
:type request: ~azure.core.rest.HttpRequest
90+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
91+
:return: The response of your network call. Does not do error handling on your response.
92+
:rtype: ~azure.core.rest.HttpResponse
93+
"""
94+
95+
request_copy = deepcopy(request)
96+
path_format_arguments = {
97+
"endpoint": self._serialize.url("self._config.base_url", self._config.base_url, "str", skip_quote=True),
98+
}
99+
100+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
101+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
102+
103+
def close(self) -> None:
104+
self._client.close()
105+
106+
def __enter__(self) -> Self:
107+
self._client.__enter__()
108+
return self
109+
110+
def __exit__(self, *exc_details: Any) -> None:
111+
self._client.__exit__(*exc_details)

‎sdk/portalservices/azure-mgmt-portalservicescopilot/azure/mgmt/portalservicescopilot/_configuration.py

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
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 PortalServicesCopilotMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
21+
"""Configuration for PortalServicesCopilotMgmtClient.
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 base_url: Service host. Default value is "https://management.azure.com".
29+
:type base_url: str
30+
:keyword api_version: The API version to use for this operation. Default value is
31+
"2024-04-01-preview". Note that overriding this default value may result in unsupported
32+
behavior.
33+
:paramtype api_version: str
34+
"""
35+
36+
def __init__(
37+
self, credential: "TokenCredential", base_url: str = "https://management.azure.com", **kwargs: Any
38+
) -> None:
39+
api_version: str = kwargs.pop("api_version", "2024-04-01-preview")
40+
41+
if credential is None:
42+
raise ValueError("Parameter 'credential' must not be None.")
43+
44+
self.credential = credential
45+
self.base_url = base_url
46+
self.api_version = api_version
47+
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
48+
kwargs.setdefault("sdk_moniker", "mgmt-portalservicescopilot/{}".format(VERSION))
49+
self.polling_interval = kwargs.get("polling_interval", 30)
50+
self._configure(**kwargs)
51+
52+
def _configure(self, **kwargs: Any) -> None:
53+
self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
54+
self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
55+
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
56+
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
57+
self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs)
58+
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
59+
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
60+
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
61+
self.authentication_policy = kwargs.get("authentication_policy")
62+
if self.credential and not self.authentication_policy:
63+
self.authentication_policy = ARMChallengeAuthenticationPolicy(
64+
self.credential, *self.credential_scopes, **kwargs
65+
)

0 commit comments

Comments
 (0)