CodeGen from PR 23357 in Azure/azure-rest-api-specs

[Hub Generated] Review request for Microsoft.Help to update swagger documentation for version preview/2023-01-01-preview (Azure#23357)

* updating api spec documentation

* updating api spec documentation #2

* updating api spec documentation #3

Author: SDKAuto

sdk/help/azure-mgmt-help/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Release History
+
+## 0.1.0 (1970-01-01)
+
+* Initial Release

sdk/help/azure-mgmt-help/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdk/help/azure-mgmt-help/MANIFEST.in

@@ -0,0 +1,8 @@
+include _meta.json
+recursive-include tests *.py *.json
+recursive-include samples *.py *.md
+include *.md
+include azure/__init__.py
+include azure/mgmt/__init__.py
+include LICENSE
+include azure/mgmt/help/py.typed

sdk/help/azure-mgmt-help/README.md

@@ -0,0 +1,64 @@
+# Microsoft Azure SDK for Python
+
+This is the Microsoft Azure MyService Management Client Library.
+This package has been tested with Python 3.7+.
+For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
+
+## _Disclaimer_
+
+_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_
+
+## Getting started
+
+### Prerequisites
+
+- Python 3.7+ is required to use this package.
+- [Azure subscription](https://azure.microsoft.com/free/)
+
+### Install the package
+
+```bash
+pip install azure-mgmt-help
+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.
+
+- `AZURE_CLIENT_ID` for Azure client ID.
+- `AZURE_TENANT_ID` for Azure tenant ID.
+- `AZURE_CLIENT_SECRET` for Azure client secret.
+
+In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
+
+With above configuration, client can be authenticated by following code:
+
+```python
+from azure.identity import DefaultAzureCredential
+from azure.mgmt.help import 
+import os
+
+sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
+client = (credential=DefaultAzureCredential(), subscription_id=sub_id)
+```
+
+## Examples
+
+Code samples for this package can be found at:
+- [Search MyService 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
+
+## Next steps
+
+## Provide Feedback
+
+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. 
+
+
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-help%2FREADME.png)

sdk/help/azure-mgmt-help/_meta.json

@@ -0,0 +1,11 @@
+{
+  "commit": "3e843e8654bc25fd9a3c9b02e5e853d78dcb4aba",
+  "repository_url": "https://github.com/Azure/azure-rest-api-specs",
+  "autorest": "3.9.2",
+  "use": [
+    "@autorest/[email protected]",
+    "@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=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/[email protected] --use=@autorest/[email protected] --version=3.9.2 --version-tolerant=False",
+  "readme": "specification/help/resource-manager/readme.md"
+}

sdk/help/azure-mgmt-help/azure/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

sdk/help/azure-mgmt-help/azure/mgmt/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

sdk/help/azure-mgmt-help/azure/mgmt/help/__init__.py

@@ -0,0 +1,26 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from ._help_rp import HelpRP
+from ._version import VERSION
+
+__version__ = VERSION
+
+try:
+    from ._patch import __all__ as _patch_all
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+except ImportError:
+    _patch_all = []
+from ._patch import patch_sdk as _patch_sdk
+
+__all__ = [
+    "HelpRP",
+]
+__all__.extend([p for p in _patch_all if p not in __all__])
+
+_patch_sdk()

sdk/help/azure-mgmt-help/azure/mgmt/help/_configuration.py

@@ -0,0 +1,92 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from typing import Any, Optional, TYPE_CHECKING
+
+from azure.core.configuration import Configuration
+from azure.core.pipeline import policies
+from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy
+
+from ._version import VERSION
+
+if TYPE_CHECKING:
+    # pylint: disable=unused-import,ungrouped-imports
+    from azure.core.credentials import TokenCredential
+
+
+class HelpRPConfiguration(Configuration):  # pylint: disable=too-many-instance-attributes
+    """Configuration for HelpRP.
+
+    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 scope: This is an extension resource provider and only resource level extension is
+     supported at the moment. Required.
+    :type scope: str
+    :param diagnostics_resource_name: Unique resource name for insight resources. Required.
+    :type diagnostics_resource_name: str
+    :param filter: Can be used to filter solutionIds by 'ProblemClassificationId'. The filter
+     supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq
+     '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq
+     '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. Default value is None.
+    :type filter: str
+    :param skiptoken: Skiptoken is only used if a previous operation returned a partial result. If
+     a previous response contains a nextLink element, the value of the nextLink element will include
+     a skiptoken parameter that specifies a starting point to use for subsequent calls. Default
+     value is None.
+    :type skiptoken: str
+    :keyword api_version: Api Version. Default value is "2023-01-01-preview". Note that overriding
+     this default value may result in unsupported behavior.
+    :paramtype api_version: str
+    """
+
+    def __init__(
+        self,
+        credential: "TokenCredential",
+        scope: str,
+        diagnostics_resource_name: str,
+        filter: Optional[str] = None,
+        skiptoken: Optional[str] = None,
+        **kwargs: Any
+    ) -> None:
+        super(HelpRPConfiguration, self).__init__(**kwargs)
+        api_version: str = kwargs.pop("api_version", "2023-01-01-preview")
+
+        if credential is None:
+            raise ValueError("Parameter 'credential' must not be None.")
+        if scope is None:
+            raise ValueError("Parameter 'scope' must not be None.")
+        if diagnostics_resource_name is None:
+            raise ValueError("Parameter 'diagnostics_resource_name' must not be None.")
+
+        self.credential = credential
+        self.scope = scope
+        self.diagnostics_resource_name = diagnostics_resource_name
+        self.filter = filter
+        self.skiptoken = skiptoken
+        self.api_version = api_version
+        self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
+        kwargs.setdefault("sdk_moniker", "mgmt-help/{}".format(VERSION))
+        self._configure(**kwargs)
+
+    def _configure(self, **kwargs: Any) -> None:
+        self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
+        self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
+        self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
+        self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
+        self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs)
+        self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
+        self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
+        self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
+        self.authentication_policy = kwargs.get("authentication_policy")
+        if self.credential and not self.authentication_policy:
+            self.authentication_policy = ARMChallengeAuthenticationPolicy(
+                self.credential, *self.credential_scopes, **kwargs
+            )

sdk/help/azure-mgmt-help/azure/mgmt/help/_help_rp.py

@@ -0,0 +1,120 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from copy import deepcopy
+from typing import Any, Optional, TYPE_CHECKING
+
+from azure.core.rest import HttpRequest, HttpResponse
+from azure.mgmt.core import ARMPipelineClient
+
+from . import models as _models
+from ._configuration import HelpRPConfiguration
+from ._serialization import Deserializer, Serializer
+from .operations import DiagnosticsOperations, DiscoverySolutionOperations, Operations
+
+if TYPE_CHECKING:
+    # pylint: disable=unused-import,ungrouped-imports
+    from azure.core.credentials import TokenCredential
+
+
+class HelpRP:  # pylint: disable=client-accepts-api-version-keyword
+    """Help RP provider.
+
+    :ivar operations: Operations operations
+    :vartype operations: azure.mgmt.help.operations.Operations
+    :ivar diagnostics: DiagnosticsOperations operations
+    :vartype diagnostics: azure.mgmt.help.operations.DiagnosticsOperations
+    :ivar discovery_solution: DiscoverySolutionOperations operations
+    :vartype discovery_solution: azure.mgmt.help.operations.DiscoverySolutionOperations
+    :param credential: Credential needed for the client to connect to Azure. Required.
+    :type credential: ~azure.core.credentials.TokenCredential
+    :param scope: This is an extension resource provider and only resource level extension is
+     supported at the moment. Required.
+    :type scope: str
+    :param diagnostics_resource_name: Unique resource name for insight resources. Required.
+    :type diagnostics_resource_name: str
+    :param filter: Can be used to filter solutionIds by 'ProblemClassificationId'. The filter
+     supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq
+     '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq
+     '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. Default value is None.
+    :type filter: str
+    :param skiptoken: Skiptoken is only used if a previous operation returned a partial result. If
+     a previous response contains a nextLink element, the value of the nextLink element will include
+     a skiptoken parameter that specifies a starting point to use for subsequent calls. Default
+     value is None.
+    :type skiptoken: str
+    :param base_url: Service URL. Default value is "https://management.azure.com".
+    :type base_url: str
+    :keyword api_version: Api Version. Default value is "2023-01-01-preview". Note that overriding
+     this default value may result in unsupported behavior.
+    :paramtype api_version: str
+    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
+     Retry-After header is present.
+    """
+
+    def __init__(
+        self,
+        credential: "TokenCredential",
+        scope: str,
+        diagnostics_resource_name: str,
+        filter: Optional[str] = None,
+        skiptoken: Optional[str] = None,
+        base_url: str = "https://management.azure.com",
+        **kwargs: Any
+    ) -> None:
+        self._config = HelpRPConfiguration(
+            credential=credential,
+            scope=scope,
+            diagnostics_resource_name=diagnostics_resource_name,
+            filter=filter,
+            skiptoken=skiptoken,
+            **kwargs
+        )
+        self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, config=self._config, **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.diagnostics = DiagnosticsOperations(self._client, self._config, self._serialize, self._deserialize)
+        self.discovery_solution = DiscoverySolutionOperations(
+            self._client, self._config, self._serialize, self._deserialize
+        )
+
+    def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
+        """Runs the network request through the client's chained policies.
+
+        >>> from azure.core.rest import HttpRequest
+        >>> request = HttpRequest("GET", "https://www.example.org/")
+        <HttpRequest [GET], url: 'https://www.example.org/'>
+        >>> response = client._send_request(request)
+        <HttpResponse: 200 OK>
+
+        For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
+
+        :param request: The network request you want to make. Required.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.HttpResponse
+        """
+
+        request_copy = deepcopy(request)
+        request_copy.url = self._client.format_url(request_copy.url)
+        return self._client.send_request(request_copy, **kwargs)
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> "HelpRP":
+        self._client.__enter__()
+        return self
+
+    def __exit__(self, *exc_details: Any) -> None:
+        self._client.__exit__(*exc_details)