Skip to content

[AutoPR azure-mgmt-orbital] [TSP Migration][orbital] TypeSpec migrated from swagger #11638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions sdk/orbital/azure-mgmt-orbital/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,67 @@
# Release History

## 3.0.0 (2025-05-06)

### Features Added

- Added model `AzureResourceManagerArmResponseAvailableContactsListResult`
- Method `ContactProfilesOperations.begin_create_or_update` has a new overload `def begin_create_or_update(self: None, resource_group_name: str, contact_profile_name: str, parameters: ContactProfile, content_type: str)`
- Method `ContactProfilesOperations.begin_create_or_update` has a new overload `def begin_create_or_update(self: None, resource_group_name: str, contact_profile_name: str, parameters: IO[bytes], content_type: str)`
- Method `ContactProfilesOperations.begin_update_tags` has a new overload `def begin_update_tags(self: None, resource_group_name: str, contact_profile_name: str, parameters: IO[bytes], content_type: str)`
- Method `ContactsOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, spacecraft_name: str, contact_name: str, parameters: IO[bytes], content_type: str)`
- Method `SpacecraftsOperations.begin_create_or_update` has a new overload `def begin_create_or_update(self: None, resource_group_name: str, spacecraft_name: str, parameters: Spacecraft, content_type: str)`
- Method `SpacecraftsOperations.begin_create_or_update` has a new overload `def begin_create_or_update(self: None, resource_group_name: str, spacecraft_name: str, parameters: IO[bytes], content_type: str)`
- Method `SpacecraftsOperations.begin_list_available_contacts` has a new overload `def begin_list_available_contacts(self: None, resource_group_name: str, spacecraft_name: str, parameters: ContactParameters, content_type: str)`
- Method `SpacecraftsOperations.begin_list_available_contacts` has a new overload `def begin_list_available_contacts(self: None, resource_group_name: str, spacecraft_name: str, parameters: IO[bytes], content_type: str)`
- Method `SpacecraftsOperations.begin_update_tags` has a new overload `def begin_update_tags(self: None, resource_group_name: str, spacecraft_name: str, parameters: IO[bytes], content_type: str)`

### Breaking Changes

- Method `AvailableContactsListResult.__init__` removed default value `None` from its parameter `value`
- Method `AvailableGroundStationListResult.__init__` removed default value `None` from its parameter `value`
- Method `ContactListResult.__init__` removed default value `None` from its parameter `value`
- Method `ContactProfileListResult.__init__` removed default value `None` from its parameter `value`
- Method `SpacecraftListResult.__init__` removed default value `None` from its parameter `value`
- Deleted or renamed model `AvailableContactsProperties`
- Deleted or renamed model `AvailableContactsSpacecraft`
- Deleted or renamed model `AvailableGroundStationProperties`
- Deleted or renamed model `AvailableGroundStationPropertiesAutoGenerated`
- Deleted or renamed model `Capability`
- Deleted or renamed model `ContactInstanceProperties`
- Deleted or renamed model `ContactParametersContactProfile`
- Deleted or renamed model `ContactProfileProperties`
- Deleted or renamed model `ContactProfilesProperties`
- Deleted or renamed model `ContactProfilesPropertiesProvisioningState`
- Deleted or renamed model `ContactsPropertiesContactProfile`
- Deleted or renamed model `ContactsPropertiesProvisioningState`
- Deleted or renamed model `ResourceIdListResultValueItem`
- Method `ContactProfilesOperations.begin_create_or_update` inserted a `positional_or_keyword` parameter `parameters`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `location` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `network_configuration` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `links` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `provisioning_state` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `minimum_viable_contact_duration` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `minimum_elevation_degrees` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `auto_tracking_configuration` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `event_hub_uri` of kind `positional_or_keyword`
- Method `ContactProfilesOperations.begin_create_or_update` deleted or renamed its parameter `third_party_configurations` of kind `positional_or_keyword`
- Deleted or renamed method `OperationsResultsOperations.begin_get`
- Method `SpacecraftsOperations.begin_create_or_update` inserted a `positional_or_keyword` parameter `parameters`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `location` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `title_line` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `tle_line1` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `tle_line2` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `links` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `tags` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `provisioning_state` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_create_or_update` deleted or renamed its parameter `norad_id` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_list_available_contacts` inserted a `positional_or_keyword` parameter `parameters`
- Method `SpacecraftsOperations.begin_list_available_contacts` deleted or renamed its parameter `contact_profile` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_list_available_contacts` deleted or renamed its parameter `ground_station_name` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_list_available_contacts` deleted or renamed its parameter `start_time` of kind `positional_or_keyword`
- Method `SpacecraftsOperations.begin_list_available_contacts` deleted or renamed its parameter `end_time` of kind `positional_or_keyword`

## 2.0.0 (2023-03-20)

### Features Added
Expand Down
14 changes: 6 additions & 8 deletions sdk/orbital/azure-mgmt-orbital/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Microsoft Azure SDK for Python

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

## _Disclaimer_
Expand All @@ -12,7 +12,7 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For

### Prerequisites

- Python 3.7+ is required to use this package.
- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package
Expand All @@ -24,7 +24,7 @@ pip install azure-identity

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
Expand All @@ -45,8 +45,9 @@ client = AzureOrbital(credential=DefaultAzureCredential(), subscription_id=sub_i

## Examples


Code samples for this package can be found at [Orbital Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com and [Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
Code samples for this package can be found at:
- [Search Orbital Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting
Expand All @@ -58,6 +59,3 @@ Code samples for this package can be found at [Orbital Management](https://docs.
If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.



10 changes: 5 additions & 5 deletions sdk/orbital/azure-mgmt-orbital/_meta.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"commit": "66174681c09b101de03fd35399080cfbccc93e8f",
"commit": "14ddb11bf9f301e56ffae91fddb70d797b8918ca",
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
"autorest": "3.9.2",
"autorest": "3.10.2",
"use": [
"@autorest/python@6.4.0",
"@autorest/modelerfour@4.24.3"
"@autorest/python@6.34.1",
"@autorest/modelerfour@4.27.0"
],
"autorest_command": "autorest specification/orbital/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 --use=@autorest/python@6.4.0 --use=@autorest/modelerfour@4.24.3 --version=3.9.2 --version-tolerant=False",
"autorest_command": "autorest specification/orbital/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.34.1 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False",
"readme": "specification/orbital/resource-manager/readme.md"
}
12 changes: 9 additions & 3 deletions sdk/orbital/azure-mgmt-orbital/azure/mgmt/orbital/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,28 @@
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
# pylint: disable=wrong-import-position

from ._azure_orbital import AzureOrbital
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from ._patch import * # pylint: disable=unused-wildcard-import

from ._azure_orbital import AzureOrbital # type: ignore
from ._version import VERSION

__version__ = VERSION

try:
from ._patch import __all__ as _patch_all
from ._patch import * # pylint: disable=unused-wildcard-import
from ._patch import *
except ImportError:
_patch_all = []
from ._patch import patch_sdk as _patch_sdk

__all__ = [
"AzureOrbital",
]
__all__.extend([p for p in _patch_all if p not in __all__])
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore

_patch_sdk()
76 changes: 51 additions & 25 deletions sdk/orbital/azure-mgmt-orbital/azure/mgmt/orbital/_azure_orbital.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,19 @@
# --------------------------------------------------------------------------

from copy import deepcopy
from typing import Any, TYPE_CHECKING
from typing import Any, Optional, TYPE_CHECKING, cast
from typing_extensions import Self

from azure.core.pipeline import policies
from azure.core.rest import HttpRequest, HttpResponse
from azure.core.settings import settings
from azure.mgmt.core import ARMPipelineClient
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
from azure.mgmt.core.tools import get_arm_endpoints

from . import models as _models
from ._configuration import AzureOrbitalConfiguration
from ._serialization import Deserializer, Serializer
from ._utils.serialization import Deserializer, Serializer
from .operations import (
AvailableGroundStationsOperations,
ContactProfilesOperations,
Expand All @@ -25,31 +30,30 @@
)

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


class AzureOrbital: # pylint: disable=client-accepts-api-version-keyword
class AzureOrbital:
"""Azure Orbital service.

:ivar operations: Operations operations
:vartype operations: azure.mgmt.orbital.operations.Operations
:ivar spacecrafts: SpacecraftsOperations operations
:vartype spacecrafts: azure.mgmt.orbital.operations.SpacecraftsOperations
:ivar contacts: ContactsOperations operations
:vartype contacts: azure.mgmt.orbital.operations.ContactsOperations
:ivar contact_profiles: ContactProfilesOperations operations
:vartype contact_profiles: azure.mgmt.orbital.operations.ContactProfilesOperations
:ivar available_ground_stations: AvailableGroundStationsOperations operations
:vartype available_ground_stations:
azure.mgmt.orbital.operations.AvailableGroundStationsOperations
:ivar contact_profiles: ContactProfilesOperations operations
:vartype contact_profiles: azure.mgmt.orbital.operations.ContactProfilesOperations
:ivar operations_results: OperationsResultsOperations operations
:vartype operations_results: azure.mgmt.orbital.operations.OperationsResultsOperations
:ivar spacecrafts: SpacecraftsOperations operations
:vartype spacecrafts: azure.mgmt.orbital.operations.SpacecraftsOperations
:ivar contacts: ContactsOperations operations
:vartype contacts: azure.mgmt.orbital.operations.ContactsOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the target subscription. Required.
:type subscription_id: str
:param base_url: Service URL. Default value is "https://management.azure.com".
:param base_url: Service URL. Default value is None.
:type base_url: str
:keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this
default value may result in unsupported behavior.
Expand All @@ -59,33 +63,55 @@ class AzureOrbital: # pylint: disable=client-accepts-api-version-keyword
"""

def __init__(
self,
credential: "TokenCredential",
subscription_id: str,
base_url: str = "https://management.azure.com",
**kwargs: Any
self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any
) -> None:
self._config = AzureOrbitalConfiguration(credential=credential, subscription_id=subscription_id, **kwargs)
self._client = ARMPipelineClient(base_url=base_url, config=self._config, **kwargs)
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
_endpoints = get_arm_endpoints(_cloud)
if not base_url:
base_url = _endpoints["resource_manager"]
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
self._config = AzureOrbitalConfiguration(
credential=credential, subscription_id=subscription_id, credential_scopes=credential_scopes, **kwargs
)

_policies = kwargs.pop("policies", None)
if _policies is None:
_policies = [
policies.RequestIdPolicy(**kwargs),
self._config.headers_policy,
self._config.user_agent_policy,
self._config.proxy_policy,
policies.ContentDecodePolicy(**kwargs),
ARMAutoResourceProviderRegistrationPolicy(),
self._config.redirect_policy,
self._config.retry_policy,
self._config.authentication_policy,
self._config.custom_hook_policy,
self._config.logging_policy,
policies.DistributedTracingPolicy(**kwargs),
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
self._config.http_logging_policy,
]
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, base_url), policies=_policies, **kwargs)

client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)}
self._serialize = Serializer(client_models)
self._deserialize = Deserializer(client_models)
self._serialize.client_side_validation = False
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
self.spacecrafts = SpacecraftsOperations(self._client, self._config, self._serialize, self._deserialize)
self.contacts = ContactsOperations(self._client, self._config, self._serialize, self._deserialize)
self.contact_profiles = ContactProfilesOperations(
self.available_ground_stations = AvailableGroundStationsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.available_ground_stations = AvailableGroundStationsOperations(
self.contact_profiles = ContactProfilesOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.operations_results = OperationsResultsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.spacecrafts = SpacecraftsOperations(self._client, self._config, self._serialize, self._deserialize)
self.contacts = ContactsOperations(self._client, self._config, self._serialize, self._deserialize)

def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
"""Runs the network request through the client's chained policies.

>>> from azure.core.rest import HttpRequest
Expand All @@ -105,12 +131,12 @@ def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:

request_copy = deepcopy(request)
request_copy.url = self._client.format_url(request_copy.url)
return self._client.send_request(request_copy, **kwargs)
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore

def close(self) -> None:
self._client.close()

def __enter__(self) -> "AzureOrbital":
def __enter__(self) -> Self:
self._client.__enter__()
return self

Expand Down
Loading