Generating Python sdk for ACL API version 2024-08-22 (Azure#38959)

* Generate Python sdk for ACL API version 2024-08-22

---------

Co-authored-by: Tai Chou <[email protected]>

Author: amruthashree18

sdk/confidentialledger/azure-confidentialledger/CHANGELOG.md

@@ -1,23 +1,38 @@
 # Release History
 
-## 1.1.2 (Unreleased)
+## 1.2.0b1 (Unreleased)
+
+### Features Added
+
+- Add and manage custom roles with the `update_user_defined_role`, `get_user_defined_role` and `delete_user_defined_role` methods
+- Add and manage ledger users with the `create_or_update_ledger_user`, `delete_ledger_user`, `get_ledger_user` and `list_ledger_users` methods
+- Add and manage programmable endpoints with the `create_user_defined_endpoint` and `get_user_defined_endpoint` methods
+- A user can now be associated with more than one role
+
 ### Other Changes
+
+- A user can now be associated with more than one role
 - Replace legacy azure core http response import with the one from azure.core.rest
+- Developers should opt to use the `*_ledger_user` methods over the `*_user` methods to manage users. The older APIs will be deprecated in the future.
 
 ## 1.1.1 (2023-08-01)
+
 ### Bugs Fixed
+
 - Allow some `ResourceNotFoundError` occurrences in `begin_wait_for_commit` to account for unexpected loss of session stickiness. These errors may occur when the connected node changes and transactions have not been fully replicated.
 
 ## 1.1.0 (2023-05-09)
 
 ### Features Added
+
 - Add `azure.confidentialledger.receipt` module for Azure Confidential Ledger write transaction receipt verification.
 - Add `verify_receipt` function to verify write transaction receipts from a receipt JSON object. The function accepts an optional, keyword-only, list of application claims parameter, which can be used to compute the claims digest from the given claims: the verification would fail if the computed digest value does not match the `claimsDigest` value present in the receipt.
-- Add `compute_claims_digest` function to compute the claims digest from a list of application claims JSON objects. 
+- Add `compute_claims_digest` function to compute the claims digest from a list of application claims JSON objects.
 - Add sample code to get and verify a write receipt from a running Confidential Ledger instance.
 - Update README with examples and documentation for receipt verification and application claims.
 
 ### Other Changes
+
 - Add dependency on Python `cryptography` library (`>= 2.1.4`)
 - Add tests for receipt verification models and receipt verification public method.
 - Add tests for application claims models and digest computation public method.
@@ -27,16 +42,19 @@
 GA Data Plane Python SDK for Confidential Ledger.
 
 ### Bugs Fixed
+
 - User ids that are certificate fingerprints are no longer URL-encoded in the request URI.
 
 ### Breaking Changes
+
 - Removed all models. Methods now return JSON directly.
 - `sub_ledger_id` fields are now named `collection_id`.
 - `azure.confidentialledger.identity_service` has been renamed to `azure.confidentialledger.certificate`.
 - `ConfidentialLedgerIdentityServiceClient` is now `ConfidentialLedgerCertificateClient`.
 - `post_ledger_entry` has been renamed to `create_ledger_entry`.
 
 ### Other Changes
+
 - Python 2.7 is no longer supported. Please use Python version 3.7 or later.
 - Convenience poller methods added for certain long-running operations.
 - Add new supported API version: `2022-05-13`.

sdk/confidentialledger/azure-confidentialledger/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/confidentialledger/azure-confidentialledger",
-  "Tag": "python/confidentialledger/azure-confidentialledger_27130e59c6"
+  "Tag": "python/confidentialledger/azure-confidentialledger_c08331db07"
 }

sdk/confidentialledger/azure-confidentialledger/azure/__init__.py

@@ -1 +1 @@
-__path__ = __import__("pkgutil").extend_path(__path__, __name__)
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/confidentialledger/azure-confidentialledger/azure/confidentialledger/__init__.py

@@ -5,20 +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 ._client import ConfidentialLedgerClient
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._client import ConfidentialLedgerClient  # type: ignore
 from ._version import VERSION
 
 __version__ = VERSION
 
 try:
     from ._patch import __all__ as _patch_all
-    from ._patch import *  # type: ignore # pylint: disable=unused-wildcard-import
+    from ._patch import *
 except ImportError:
     _patch_all = []
 from ._patch import patch_sdk as _patch_sdk
 
-__all__ = ["ConfidentialLedgerClient"]
-__all__.extend([p for p in _patch_all if p not in __all__])
+__all__ = [
+    "ConfidentialLedgerClient",
+]
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
 
 _patch_sdk()

sdk/confidentialledger/azure-confidentialledger/azure/confidentialledger/_client.py

@@ -7,46 +7,59 @@
 # --------------------------------------------------------------------------
 
 from copy import deepcopy
-from typing import Any, TYPE_CHECKING
+from typing import Any
+from typing_extensions import Self
 
 from azure.core import PipelineClient
+from azure.core.pipeline import policies
 from azure.core.rest import HttpRequest, HttpResponse
 
 from ._configuration import ConfidentialLedgerClientConfiguration
 from ._operations import ConfidentialLedgerClientOperationsMixin
 from ._serialization import Deserializer, Serializer
 
-if TYPE_CHECKING:
-    # pylint: disable=unused-import,ungrouped-imports
-    from typing import Dict
 
-
-class ConfidentialLedgerClient(
-    ConfidentialLedgerClientOperationsMixin
-):  # pylint: disable=client-accepts-api-version-keyword
+class ConfidentialLedgerClient(ConfidentialLedgerClientOperationsMixin):
     """The ConfidentialLedgerClient writes and retrieves ledger entries against the Confidential
     Ledger service.
 
-    :param ledger_endpoint: The Confidential Ledger URL, for example
+    :param endpoint: The Confidential Ledger URL, for example
      https://contoso.confidentialledger.azure.com. Required.
-    :type ledger_endpoint: str
-    :keyword api_version: Api Version. Default value is "2022-05-13". Note that overriding this
-     default value may result in unsupported behavior.
+    :type endpoint: str
+    :keyword api_version: Api Version. Default value is "2024-08-22-preview". Note that overriding
+     this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
     def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
-        self, ledger_endpoint: str, **kwargs: Any
+        self, endpoint: str, **kwargs: Any
     ) -> None:
-        _endpoint = "{ledgerEndpoint}"
-        self._config = ConfidentialLedgerClientConfiguration(ledger_endpoint=ledger_endpoint, **kwargs)
-        self._client = PipelineClient(base_url=_endpoint, config=self._config, **kwargs)
+        _endpoint = "{endpoint}"
+        self._config = ConfidentialLedgerClientConfiguration(endpoint=endpoint, **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),
+                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: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
 
         self._serialize = Serializer()
         self._deserialize = Deserializer()
         self._serialize.client_side_validation = False
 
-    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
@@ -66,23 +79,18 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
 
         request_copy = deepcopy(request)
         path_format_arguments = {
-            "ledgerEndpoint": self._serialize.url(
-                "self._config.ledger_endpoint", self._config.ledger_endpoint, "str", skip_quote=True
-            ),
+            "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
         }
 
         request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
-        return self._client.send_request(request_copy, **kwargs)
+        return self._client.send_request(request_copy, stream=stream, **kwargs)  # type: ignore
 
-    def close(self):
-        # type: () -> None
+    def close(self) -> None:
         self._client.close()
 
-    def __enter__(self):
-        # type: () -> ConfidentialLedgerClient
+    def __enter__(self) -> Self:
         self._client.__enter__()
         return self
 
-    def __exit__(self, *exc_details):
-        # type: (Any) -> None
+    def __exit__(self, *exc_details: Any) -> None:
         self._client.__exit__(*exc_details)

sdk/confidentialledger/azure-confidentialledger/azure/confidentialledger/_configuration.py

@@ -8,48 +8,44 @@
 
 from typing import Any
 
-from azure.core.configuration import Configuration
 from azure.core.pipeline import policies
 
 from ._version import VERSION
 
 
-class ConfidentialLedgerClientConfiguration(Configuration):  # pylint: disable=too-many-instance-attributes
+class ConfidentialLedgerClientConfiguration:  # pylint: disable=too-many-instance-attributes
     """Configuration for ConfidentialLedgerClient.
 
     Note that all parameters used to create this instance are saved as instance
     attributes.
 
-    :param ledger_endpoint: The Confidential Ledger URL, for example
+    :param endpoint: The Confidential Ledger URL, for example
      https://contoso.confidentialledger.azure.com. Required.
-    :type ledger_endpoint: str
-    :keyword api_version: Api Version. Default value is "2022-05-13". Note that overriding this
-     default value may result in unsupported behavior.
+    :type endpoint: str
+    :keyword api_version: Api Version. Default value is "2024-08-22-preview". Note that overriding
+     this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
-    def __init__(self, ledger_endpoint: str, **kwargs: Any) -> None:
-        super(ConfidentialLedgerClientConfiguration, self).__init__(**kwargs)
-        api_version = kwargs.pop("api_version", "2022-05-13")  # type: str
+    def __init__(self, endpoint: str, **kwargs: Any) -> None:
+        api_version: str = kwargs.pop("api_version", "2024-08-22-preview")
 
-        if ledger_endpoint is None:
-            raise ValueError("Parameter 'ledger_endpoint' must not be None.")
+        if endpoint is None:
+            raise ValueError("Parameter 'endpoint' must not be None.")
 
-        self.ledger_endpoint = ledger_endpoint
+        self.endpoint = endpoint
         self.api_version = api_version
         kwargs.setdefault("sdk_moniker", "confidentialledger/{}".format(VERSION))
+        self.polling_interval = kwargs.get("polling_interval", 30)
         self._configure(**kwargs)
 
-    def _configure(
-        self, **kwargs  # type: Any
-    ):
-        # type: (...) -> None
+    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 policies.HttpLoggingPolicy(**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.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
         self.authentication_policy = kwargs.get("authentication_policy")

sdk/confidentialledger/azure-confidentialledger/azure/confidentialledger/_operations/__init__.py

@@ -5,15 +5,21 @@
 # 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 ._operations import ConfidentialLedgerClientOperationsMixin
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._operations import ConfidentialLedgerClientOperationsMixin  # type: ignore
 
 from ._patch import __all__ as _patch_all
-from ._patch import *  # type: ignore # pylint: disable=unused-wildcard-import
+from ._patch import *
 from ._patch import patch_sdk as _patch_sdk
 
 __all__ = [
     "ConfidentialLedgerClientOperationsMixin",
 ]
-__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()