[Monitor Ingestion] Regen code with cred flags (Azure#30739)

This adds two additional credential flags to the swagger, and regenerates the code.
This results in the default scope being set in the configuration file.
There is no behavior change, but this opens up the client to custom
`authentication_policies` and `credential_scopes`.

Doc strings for Client classes were also updated.

Signed-off-by: Paul Van Eck <[email protected]>

Author: pvaneck

sdk/monitor/azure-monitor-ingestion/CHANGELOG.md

@@ -10,6 +10,8 @@
 
 ### Other Changes
 
+- Allow for custom authentication policies or credential scopes to be passed to the client. ([#30739](https://github.com/Azure/azure-sdk-for-python/pull/30739/))
+
 ## 1.0.1 (2023-04-11)
 
 ### Bugs Fixed

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/_configuration.py

@@ -6,17 +6,11 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-import sys
 from typing import Any, TYPE_CHECKING
 
 from azure.core.configuration import Configuration
 from azure.core.pipeline import policies
 
-if sys.version_info >= (3, 8):
-    from typing import Literal  # pylint: disable=no-name-in-module, ungrouped-imports
-else:
-    from typing_extensions import Literal  # type: ignore  # pylint: disable=ungrouped-imports
-
 if TYPE_CHECKING:
     # pylint: disable=unused-import,ungrouped-imports
     from azure.core.credentials import TokenCredential
@@ -42,7 +36,7 @@ class LogsIngestionClientConfiguration(Configuration):  # pylint: disable=too-ma
 
     def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
         super(LogsIngestionClientConfiguration, self).__init__(**kwargs)
-        api_version: Literal["2023-01-01"] = kwargs.pop("api_version", "2023-01-01")
+        api_version: str = kwargs.pop("api_version", "2023-01-01")
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")
@@ -52,7 +46,7 @@ def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any)
         self.endpoint = endpoint
         self.credential = credential
         self.api_version = api_version
-        self.credential_scopes = kwargs.pop("credential_scopes", ["user_impersonation"])
+        self.credential_scopes = kwargs.pop("credential_scopes", ["https://monitor.azure.com//.default"])
         kwargs.setdefault("sdk_moniker", "monitor-ingestion/{}".format(VERSION))
         self._configure(**kwargs)
 

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/_operations/_operations.py

@@ -6,6 +6,7 @@
 # Code generated by Microsoft (R) AutoRest Code Generator.
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
+from io import IOBase
 import sys
 from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union
 
@@ -30,10 +31,6 @@
     from collections.abc import MutableMapping
 else:
     from typing import MutableMapping  # type: ignore  # pylint: disable=ungrouped-imports
-if sys.version_info >= (3, 8):
-    from typing import Literal  # pylint: disable=no-name-in-module, ungrouped-imports
-else:
-    from typing_extensions import Literal  # type: ignore  # pylint: disable=ungrouped-imports
 JSON = MutableMapping[str, Any]  # pylint: disable=unsubscriptable-object
 T = TypeVar("T")
 ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]]
@@ -54,7 +51,7 @@ def build_logs_ingestion_upload_request(
     _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
 
     content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
-    api_version: Literal["2023-01-01"] = kwargs.pop("api_version", _params.pop("api-version", "2023-01-01"))
+    api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-01-01"))
     accept = _headers.pop("Accept", "application/json")
 
     # Construct URL
@@ -133,7 +130,7 @@ def upload(  # pylint: disable=inconsistent-return-statements
         content_type = content_type or "application/json"
         _json = None
         _content = None
-        if isinstance(body, (IO, bytes)):
+        if isinstance(body, (IOBase, bytes)):
             _content = body
         else:
             _json = body

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/_patch.py

@@ -6,37 +6,23 @@
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
-from typing import TYPE_CHECKING, Any
-from azure.core.pipeline.policies import BearerTokenCredentialPolicy
 from ._client import LogsIngestionClient as GeneratedClient
 from ._models import LogsUploadError
 
-if TYPE_CHECKING:
-    from azure.core.credentials import TokenCredential
-
 
 class LogsIngestionClient(GeneratedClient):
-    """Azure Monitor Data Collection Python Client.
+    """The synchronous client for uploading logs to Azure Monitor.
 
     :param endpoint: The Data Collection Endpoint for the Data Collection Rule, for example
      https://dce-name.eastus-2.ingest.monitor.azure.com.
     :type endpoint: str
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials.TokenCredential
-    :keyword api_version: Api Version. Default value is "2021-11-01-preview". Note that overriding
+    :keyword api_version: Api Version. Default value is "2023-01-01". Note that overriding
      this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
-    def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
-        scope = "https://monitor.azure.com//.default"
-        super().__init__(
-            endpoint,
-            credential,
-            authentication_policy=BearerTokenCredentialPolicy(credential, scope, **kwargs),
-            **kwargs
-        )
-
 
 __all__ = ["LogsIngestionClient", "LogsUploadError"]
 

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/aio/_configuration.py

@@ -6,17 +6,11 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-import sys
 from typing import Any, TYPE_CHECKING
 
 from azure.core.configuration import Configuration
 from azure.core.pipeline import policies
 
-if sys.version_info >= (3, 8):
-    from typing import Literal  # pylint: disable=no-name-in-module, ungrouped-imports
-else:
-    from typing_extensions import Literal  # type: ignore  # pylint: disable=ungrouped-imports
-
 if TYPE_CHECKING:
     # pylint: disable=unused-import,ungrouped-imports
     from azure.core.credentials_async import AsyncTokenCredential
@@ -42,7 +36,7 @@ class LogsIngestionClientConfiguration(Configuration):  # pylint: disable=too-ma
 
     def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None:
         super(LogsIngestionClientConfiguration, self).__init__(**kwargs)
-        api_version: Literal["2023-01-01"] = kwargs.pop("api_version", "2023-01-01")
+        api_version: str = kwargs.pop("api_version", "2023-01-01")
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")
@@ -52,7 +46,7 @@ def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs:
         self.endpoint = endpoint
         self.credential = credential
         self.api_version = api_version
-        self.credential_scopes = kwargs.pop("credential_scopes", ["user_impersonation"])
+        self.credential_scopes = kwargs.pop("credential_scopes", ["https://monitor.azure.com//.default"])
         kwargs.setdefault("sdk_moniker", "monitor-ingestion/{}".format(VERSION))
         self._configure(**kwargs)
 

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/aio/_operations/_operations.py

@@ -6,6 +6,7 @@
 # Code generated by Microsoft (R) AutoRest Code Generator.
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
+from io import IOBase
 import sys
 from typing import Any, Callable, Dict, IO, List, Optional, TypeVar, Union
 
@@ -87,7 +88,7 @@ async def upload(  # pylint: disable=inconsistent-return-statements
         content_type = content_type or "application/json"
         _json = None
         _content = None
-        if isinstance(body, (IO, bytes)):
+        if isinstance(body, (IOBase, bytes)):
             _content = body
         else:
             _json = body

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/aio/_patch.py

@@ -6,37 +6,24 @@
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
-from typing import List, Any, TYPE_CHECKING
-from azure.core.pipeline.policies import AsyncBearerTokenCredentialPolicy
+from typing import List
 from ._client import LogsIngestionClient as GeneratedClient
 
-if TYPE_CHECKING:
-    from azure.core.credentials_async import AsyncTokenCredential
-
 
 class LogsIngestionClient(GeneratedClient):
-    """Azure Monitor Data Collection Python Client.
+    """The asynchronous client for uploading logs to Azure Monitor.
 
     :param endpoint: The Data Collection Endpoint for the Data Collection Rule, for example
      https://dce-name.eastus-2.ingest.monitor.azure.com.
     :type endpoint: str
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials_async.AsyncTokenCredential
-    :keyword api_version: Api Version. Default value is "2021-11-01-preview". Note that overriding
+    :keyword api_version: Api Version. Default value is "2023-01-01". Note that overriding
      this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
-    def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None:
-        scope = "https://monitor.azure.com//.default"
-        super().__init__(
-            endpoint, credential, authentication_policy=AsyncBearerTokenCredentialPolicy(credential, scope), **kwargs
-        )
-
-
-__all__: List[str] = [
-    "LogsIngestionClient"
-]  # Add all objects you want publicly available to users at this package level
+__all__: List[str] = ["LogsIngestionClient"]
 
 
 def patch_sdk():

sdk/monitor/azure-monitor-ingestion/swagger/README.PYTHON.md

@@ -13,6 +13,8 @@ license-header: MICROSOFT_MIT_NO_VERSION
 no-namespace-folders: true
 output-folder: ../azure/monitor/ingestion
 source-code-folder-path: ./azure/monitor/ingestion
+add-credential: true
+credential-scopes: https://monitor.azure.com//.default
 input-file:
     - https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/monitor/data-plane/ingestion/stable/2023-01-01/DataCollectionRules.json
 python: true