Skip to content

[AutoPR azure-mgmt-selfhelp] Convert Help swagger to Tsp #11627

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
32 changes: 32 additions & 0 deletions sdk/selfhelp/azure-mgmt-selfhelp/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# Release History

## 2.0.0b5 (2025-05-09)

### Features Added

- Method `DiagnosticsOperations.begin_create` has a new overload `def begin_create(self: None, scope: str, diagnostics_resource_name: str, diagnostic_resource_request: DiagnosticResource, content_type: str)`
- Method `DiagnosticsOperations.begin_create` has a new overload `def begin_create(self: None, scope: str, diagnostics_resource_name: str, diagnostic_resource_request: IO[bytes], content_type: str)`
- Method `DiscoverySolutionNLPOperations.discover_solutions` has a new overload `def discover_solutions(self: None, discover_solution_request: DiscoveryNlpRequest, content_type: str)`
- Method `DiscoverySolutionNLPOperations.discover_solutions` has a new overload `def discover_solutions(self: None, discover_solution_request: IO[bytes], content_type: str)`
- Method `DiscoverySolutionNLPOperations.discover_solutions_by_subscription` has a new overload `def discover_solutions_by_subscription(self: None, discover_solution_request: DiscoveryNlpRequest, content_type: str)`
- Method `DiscoverySolutionNLPOperations.discover_solutions_by_subscription` has a new overload `def discover_solutions_by_subscription(self: None, discover_solution_request: IO[bytes], content_type: str)`
- Method `SimplifiedSolutionsOperations.begin_create` has a new overload `def begin_create(self: None, scope: str, simplified_solutions_resource_name: str, simplified_solutions_request_body: SimplifiedSolutionsResource, content_type: str)`
- Method `SimplifiedSolutionsOperations.begin_create` has a new overload `def begin_create(self: None, scope: str, simplified_solutions_resource_name: str, simplified_solutions_request_body: IO[bytes], content_type: str)`
- Method `SolutionOperations.begin_create` has a new overload `def begin_create(self: None, scope: str, solution_resource_name: str, solution_request_body: SolutionResource, content_type: str)`
- Method `SolutionOperations.begin_create` has a new overload `def begin_create(self: None, scope: str, solution_resource_name: str, solution_request_body: IO[bytes], content_type: str)`
- Method `SolutionOperations.begin_update` has a new overload `def begin_update(self: None, scope: str, solution_resource_name: str, solution_patch_request_body: SolutionPatchRequestBody, content_type: str)`
- Method `SolutionOperations.begin_update` has a new overload `def begin_update(self: None, scope: str, solution_resource_name: str, solution_patch_request_body: IO[bytes], content_type: str)`
- Method `TroubleshootersOperations.create` has a new overload `def create(self: None, scope: str, troubleshooter_name: str, create_troubleshooter_request_body: TroubleshooterResource, content_type: str)`
- Method `TroubleshootersOperations.create` has a new overload `def create(self: None, scope: str, troubleshooter_name: str, create_troubleshooter_request_body: IO[bytes], content_type: str)`

### Breaking Changes

- Method `SelfHelpMgmtClient.__init__` inserted a `positional_or_keyword` parameter `subscription_id`
- Method `DiscoveryResponse.__init__` removed default value `None` from its parameter `value`
- Method `DiagnosticsOperations.begin_create` removed default value `None` from its parameter `diagnostic_resource_request`
- Method `DiscoverySolutionNLPOperations.discover_solutions` removed default value `None` from its parameter `discover_solution_request`
- Method `DiscoverySolutionNLPOperations.discover_solutions_by_subscription` removed default value `None` from its parameter `discover_solution_request`
- Method `DiscoverySolutionNLPOperations.discover_solutions_by_subscription` deleted or renamed its parameter `subscription_id` of kind `positional_or_keyword`
- Method `SimplifiedSolutionsOperations.begin_create` removed default value `None` from its parameter `simplified_solutions_request_body`
- Method `SolutionOperations.begin_create` removed default value `None` from its parameter `solution_request_body`
- Method `SolutionOperations.begin_update` removed default value `None` from its parameter `solution_patch_request_body`
- Method `TroubleshootersOperations.create` removed default value `None` from its parameter `create_troubleshooter_request_body`

## 2.0.0b4 (2024-05-27)

### Features Added
Expand Down
6 changes: 3 additions & 3 deletions sdk/selfhelp/azure-mgmt-selfhelp/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 Selfhelp Management Client Library.
This package has been tested with Python 3.8+.
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.8+ 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 Down
6 changes: 3 additions & 3 deletions sdk/selfhelp/azure-mgmt-selfhelp/_meta.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"commit": "c3cc9abe085093ba880ee3eeb792edb4fa789553",
"commit": "51be344f3e6ae8e3e9b2a8b4c2676ee74c31bd4a",
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
"autorest": "3.10.2",
"use": [
"@autorest/python@6.13.16",
"@autorest/python@6.34.1",
"@autorest/[email protected]"
],
"autorest_command": "autorest specification/help/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.13.16 --use=@autorest/[email protected] --version=3.10.2 --version-tolerant=False",
"autorest_command": "autorest specification/help/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/[email protected] --version=3.10.2 --version-tolerant=False",
"readme": "specification/help/resource-manager/readme.md"
}
12 changes: 9 additions & 3 deletions sdk/selfhelp/azure-mgmt-selfhelp/azure/mgmt/selfhelp/__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 ._self_help_mgmt_client import SelfHelpMgmtClient
from typing import TYPE_CHECKING

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

from ._self_help_mgmt_client import SelfHelpMgmtClient # 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__ = [
"SelfHelpMgmtClient",
]
__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()
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,34 @@
from ._version import VERSION

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


class SelfHelpMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long
class SelfHelpMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes
"""Configuration for SelfHelpMgmtClient.

Note that all parameters used to create this instance are saved as instance
attributes.

: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. The value must be an UUID. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2024-03-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
"""

def __init__(self, credential: "TokenCredential", **kwargs: Any) -> None:
def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs: Any) -> None:
api_version: str = kwargs.pop("api_version", "2024-03-01-preview")

if credential is None:
raise ValueError("Parameter 'credential' must not be None.")
if subscription_id is None:
raise ValueError("Parameter 'subscription_id' must not be None.")

self.credential = credential
self.subscription_id = subscription_id
self.api_version = api_version
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
kwargs.setdefault("sdk_moniker", "mgmt-selfhelp/{}".format(VERSION))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +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 SelfHelpMgmtClientConfiguration
from ._serialization import Deserializer, Serializer
from ._utils.serialization import Deserializer, Serializer
from .operations import (
CheckNameAvailabilityOperations,
DiagnosticsOperations,
Expand All @@ -30,35 +33,36 @@
)

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


class SelfHelpMgmtClient: # pylint: disable=client-accepts-api-version-keyword,too-many-instance-attributes
class SelfHelpMgmtClient: # pylint: disable=too-many-instance-attributes
"""Help RP provider.

:ivar operations: Operations operations
:vartype operations: azure.mgmt.selfhelp.operations.Operations
:ivar check_name_availability: CheckNameAvailabilityOperations operations
:vartype check_name_availability:
azure.mgmt.selfhelp.operations.CheckNameAvailabilityOperations
:ivar diagnostics: DiagnosticsOperations operations
:vartype diagnostics: azure.mgmt.selfhelp.operations.DiagnosticsOperations
:ivar discovery_solution: DiscoverySolutionOperations operations
:vartype discovery_solution: azure.mgmt.selfhelp.operations.DiscoverySolutionOperations
:ivar solution: SolutionOperations operations
:vartype solution: azure.mgmt.selfhelp.operations.SolutionOperations
:ivar simplified_solutions: SimplifiedSolutionsOperations operations
:vartype simplified_solutions: azure.mgmt.selfhelp.operations.SimplifiedSolutionsOperations
:ivar solution: SolutionOperations operations
:vartype solution: azure.mgmt.selfhelp.operations.SolutionOperations
:ivar troubleshooters: TroubleshootersOperations operations
:vartype troubleshooters: azure.mgmt.selfhelp.operations.TroubleshootersOperations
:ivar solution_self_help: SolutionSelfHelpOperations operations
:vartype solution_self_help: azure.mgmt.selfhelp.operations.SolutionSelfHelpOperations
:ivar discovery_solution_nlp: DiscoverySolutionNLPOperations operations
:vartype discovery_solution_nlp: azure.mgmt.selfhelp.operations.DiscoverySolutionNLPOperations
:ivar discovery_solution: DiscoverySolutionOperations operations
:vartype discovery_solution: azure.mgmt.selfhelp.operations.DiscoverySolutionOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.selfhelp.operations.Operations
:ivar solution_self_help: SolutionSelfHelpOperations operations
:vartype solution_self_help: azure.mgmt.selfhelp.operations.SolutionSelfHelpOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param base_url: Service URL. Default value is "https://management.azure.com".
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:param base_url: Service URL. Default value is None.
:type base_url: str
:keyword api_version: Api Version. Default value is "2024-03-01-preview". Note that overriding
this default value may result in unsupported behavior.
Expand All @@ -68,9 +72,17 @@ class SelfHelpMgmtClient: # pylint: disable=client-accepts-api-version-keyword,
"""

def __init__(
self, credential: "TokenCredential", 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 = SelfHelpMgmtClientConfiguration(credential=credential, **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 = SelfHelpMgmtClientConfiguration(
credential=credential, subscription_id=subscription_id, credential_scopes=credential_scopes, **kwargs
)

_policies = kwargs.pop("policies", None)
if _policies is None:
_policies = [
Expand All @@ -89,29 +101,29 @@ def __init__(
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
self._config.http_logging_policy,
]
self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, policies=_policies, **kwargs)
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.check_name_availability = CheckNameAvailabilityOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.diagnostics = DiagnosticsOperations(self._client, self._config, self._serialize, self._deserialize)
self.discovery_solution = DiscoverySolutionOperations(
self.simplified_solutions = SimplifiedSolutionsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.solution = SolutionOperations(self._client, self._config, self._serialize, self._deserialize)
self.simplified_solutions = SimplifiedSolutionsOperations(
self.troubleshooters = TroubleshootersOperations(self._client, self._config, self._serialize, self._deserialize)
self.discovery_solution_nlp = DiscoverySolutionNLPOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.troubleshooters = TroubleshootersOperations(self._client, self._config, self._serialize, self._deserialize)
self.solution_self_help = SolutionSelfHelpOperations(
self.discovery_solution = DiscoverySolutionOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.discovery_solution_nlp = DiscoverySolutionNLPOperations(
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
self.solution_self_help = SolutionSelfHelpOperations(
self._client, self._config, self._serialize, self._deserialize
)

Expand Down Expand Up @@ -140,7 +152,7 @@ def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs:
def close(self) -> None:
self._client.close()

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,3 @@
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

from azure.core.pipeline.transport import HttpRequest


def _convert_request(request, files=None):
data = request.content if not files else None
request = HttpRequest(method=request.method, url=request.url, headers=request.headers, data=data)
if files:
request.set_formdata_body(files)
return request
Loading