Skip to content

Commit c4031e0

Browse files
[AutoRelease] t2-planetarycomputer-2025-05-20-27864(can only be merged by SDK owner) (#41208)
* code and test * update testcase --------- Co-authored-by: azure-sdk <PythonSdkPipelines> Co-authored-by: ChenxiJiang333 <[email protected]>
1 parent 65c1aef commit c4031e0

Some content is hidden

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

50 files changed

+7490
-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-05-20)
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: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
recursive-include tests *.py *.json
2+
recursive-include samples *.py *.md
3+
include *.md
4+
include azure/__init__.py
5+
include azure/mgmt/__init__.py
6+
include LICENSE
7+
include azure/mgmt/planetarycomputer/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 Planetarycomputer 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-planetarycomputer
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.planetarycomputer import PlanetaryComputerMgmtClient
40+
import os
41+
42+
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
43+
client = PlanetaryComputerMgmtClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
44+
```
45+
46+
## Examples
47+
48+
Code samples for this package can be found at:
49+
- [Search Planetarycomputer 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": "03a6598cdc38924f9eaaeb03f8ef151f5aeff449",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/orbitalplanetarycomputer/Orbital.Management",
5+
"emitterVersion": "0.44.2"
6+
}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"CrossLanguagePackageId": "Microsoft.Spatio",
3+
"CrossLanguageDefinitionId": {
4+
"azure.mgmt.planetarycomputer.models.ErrorAdditionalInfo": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo",
5+
"azure.mgmt.planetarycomputer.models.ErrorDetail": "Azure.ResourceManager.CommonTypes.ErrorDetail",
6+
"azure.mgmt.planetarycomputer.models.ErrorResponse": "Azure.ResourceManager.CommonTypes.ErrorResponse",
7+
"azure.mgmt.planetarycomputer.models.Resource": "Azure.ResourceManager.CommonTypes.Resource",
8+
"azure.mgmt.planetarycomputer.models.TrackedResource": "Azure.ResourceManager.CommonTypes.TrackedResource",
9+
"azure.mgmt.planetarycomputer.models.GeoCatalog": "Microsoft.Spatio.GeoCatalog",
10+
"azure.mgmt.planetarycomputer.models.GeoCatalogProperties": "Microsoft.Spatio.GeoCatalogProperties",
11+
"azure.mgmt.planetarycomputer.models.GeoCatalogUpdate": "Microsoft.Spatio.GeoCatalogUpdate",
12+
"azure.mgmt.planetarycomputer.models.ManagedServiceIdentity": "Azure.ResourceManager.CommonTypes.ManagedServiceIdentity",
13+
"azure.mgmt.planetarycomputer.models.ManagedServiceIdentityUpdate": "Microsoft.Spatio.ManagedServiceIdentityUpdate",
14+
"azure.mgmt.planetarycomputer.models.SystemData": "Azure.ResourceManager.CommonTypes.SystemData",
15+
"azure.mgmt.planetarycomputer.models.UserAssignedIdentity": "Azure.ResourceManager.CommonTypes.UserAssignedIdentity",
16+
"azure.mgmt.planetarycomputer.models.CreatedByType": "Azure.ResourceManager.CommonTypes.createdByType",
17+
"azure.mgmt.planetarycomputer.models.CatalogTier": "Microsoft.Spatio.CatalogTier",
18+
"azure.mgmt.planetarycomputer.models.ProvisioningState": "Microsoft.Spatio.ProvisioningState",
19+
"azure.mgmt.planetarycomputer.models.AutoGeneratedDomainNameLabelScope": "Microsoft.Spatio.AutoGeneratedDomainNameLabelScope",
20+
"azure.mgmt.planetarycomputer.models.ManagedServiceIdentityType": "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityType",
21+
"azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations.get": "Microsoft.Spatio.GeoCatalogs.get",
22+
"azure.mgmt.planetarycomputer.aio.operations.GeoCatalogsOperations.get": "Microsoft.Spatio.GeoCatalogs.get",
23+
"azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations.begin_create": "Microsoft.Spatio.GeoCatalogs.create",
24+
"azure.mgmt.planetarycomputer.aio.operations.GeoCatalogsOperations.begin_create": "Microsoft.Spatio.GeoCatalogs.create",
25+
"azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations.begin_update": "Microsoft.Spatio.GeoCatalogs.update",
26+
"azure.mgmt.planetarycomputer.aio.operations.GeoCatalogsOperations.begin_update": "Microsoft.Spatio.GeoCatalogs.update",
27+
"azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations.begin_delete": "Microsoft.Spatio.GeoCatalogs.delete",
28+
"azure.mgmt.planetarycomputer.aio.operations.GeoCatalogsOperations.begin_delete": "Microsoft.Spatio.GeoCatalogs.delete",
29+
"azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations.list_by_resource_group": "Microsoft.Spatio.GeoCatalogs.listByResourceGroup",
30+
"azure.mgmt.planetarycomputer.aio.operations.GeoCatalogsOperations.list_by_resource_group": "Microsoft.Spatio.GeoCatalogs.listByResourceGroup",
31+
"azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations.list_by_subscription": "Microsoft.Spatio.GeoCatalogs.listBySubscription",
32+
"azure.mgmt.planetarycomputer.aio.operations.GeoCatalogsOperations.list_by_subscription": "Microsoft.Spatio.GeoCatalogs.listBySubscription"
33+
}
34+
}
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 PlanetaryComputerMgmtClient # 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+
"PlanetaryComputerMgmtClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
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 PlanetaryComputerMgmtClientConfiguration
21+
from ._utils.serialization import Deserializer, Serializer
22+
from .operations import GeoCatalogsOperations
23+
24+
if TYPE_CHECKING:
25+
from azure.core.credentials import TokenCredential
26+
27+
28+
class PlanetaryComputerMgmtClient:
29+
"""Microsoft Planetary Computer Pro Resource Provider management API.
30+
31+
:ivar geo_catalogs: GeoCatalogsOperations operations
32+
:vartype geo_catalogs: azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations
33+
:param credential: Credential used to authenticate requests to the service. Required.
34+
:type credential: ~azure.core.credentials.TokenCredential
35+
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
36+
:type subscription_id: str
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
40+
"2025-02-11-preview". Note that overriding this default value may result in unsupported
41+
behavior.
42+
:paramtype api_version: str
43+
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
44+
Retry-After header is present.
45+
"""
46+
47+
def __init__(
48+
self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any
49+
) -> None:
50+
_endpoint = "{endpoint}"
51+
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
52+
_endpoints = get_arm_endpoints(_cloud)
53+
if not base_url:
54+
base_url = _endpoints["resource_manager"]
55+
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
56+
self._config = PlanetaryComputerMgmtClientConfiguration(
57+
credential=credential,
58+
subscription_id=subscription_id,
59+
base_url=cast(str, base_url),
60+
credential_scopes=credential_scopes,
61+
**kwargs
62+
)
63+
64+
_policies = kwargs.pop("policies", None)
65+
if _policies is None:
66+
_policies = [
67+
policies.RequestIdPolicy(**kwargs),
68+
self._config.headers_policy,
69+
self._config.user_agent_policy,
70+
self._config.proxy_policy,
71+
policies.ContentDecodePolicy(**kwargs),
72+
ARMAutoResourceProviderRegistrationPolicy(),
73+
self._config.redirect_policy,
74+
self._config.retry_policy,
75+
self._config.authentication_policy,
76+
self._config.custom_hook_policy,
77+
self._config.logging_policy,
78+
policies.DistributedTracingPolicy(**kwargs),
79+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
80+
self._config.http_logging_policy,
81+
]
82+
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, _endpoint), policies=_policies, **kwargs)
83+
84+
self._serialize = Serializer()
85+
self._deserialize = Deserializer()
86+
self._serialize.client_side_validation = False
87+
self.geo_catalogs = GeoCatalogsOperations(self._client, self._config, self._serialize, self._deserialize)
88+
89+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
90+
"""Runs the network request through the client's chained policies.
91+
92+
>>> from azure.core.rest import HttpRequest
93+
>>> request = HttpRequest("GET", "https://www.example.org/")
94+
<HttpRequest [GET], url: 'https://www.example.org/'>
95+
>>> response = client.send_request(request)
96+
<HttpResponse: 200 OK>
97+
98+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
99+
100+
:param request: The network request you want to make. Required.
101+
:type request: ~azure.core.rest.HttpRequest
102+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
103+
:return: The response of your network call. Does not do error handling on your response.
104+
:rtype: ~azure.core.rest.HttpResponse
105+
"""
106+
107+
request_copy = deepcopy(request)
108+
path_format_arguments = {
109+
"endpoint": self._serialize.url("self._config.base_url", self._config.base_url, "str", skip_quote=True),
110+
}
111+
112+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
113+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
114+
115+
def close(self) -> None:
116+
self._client.close()
117+
118+
def __enter__(self) -> Self:
119+
self._client.__enter__()
120+
return self
121+
122+
def __exit__(self, *exc_details: Any) -> None:
123+
self._client.__exit__(*exc_details)

0 commit comments

Comments
 (0)