[AutoPR azure-mgmt-alertsmanagement] Add documentation and some small fixes in PR for Microsoft.AlertsManagement-2025-03-01-preview

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

@@ -1,5 +1,104 @@
 # Release History
 
+## 2.0.0b3 (2025-03-26)
+
+### Features Added
+
+  - Client `AlertsManagementClient` added operation group `alert_rule_recommendations`
+  - Client `AlertsManagementClient` added operation group `issue`
+  - Model `Essentials` added property `has_enrichments`
+  - Model `Essentials` added property `is_stateful_alert`
+  - Model `Essentials` added property `correlation_details`
+  - Enum `MonitorService` added member `RESOURCE_HEALTH`
+  - Model `Resource` added property `system_data`
+  - Added enum `AddedByType`
+  - Added model `AlertEnrichmentItem`
+  - Added model `AlertEnrichmentProperties`
+  - Added model `AlertEnrichmentResponse`
+  - Added model `AlertEnrichmentsList`
+  - Added model `AlertRuleRecommendationResource`
+  - Added model `AlertRuleRecommendationsListResponse`
+  - Added model `CorrelationDetails`
+  - Added model `ErrorDetailAutoGenerated`
+  - Added model `ErrorDetailAutoGenerated2`
+  - Added model `ErrorResponseAutoGenerated4`
+  - Added model `ErrorResponseAutoGenerated5`
+  - Added model `FetchInvestigationResultParameters`
+  - Added enum `InvestigationEntityType`
+  - Added model `InvestigationExecution`
+  - Added enum `InvestigationExecutionRunState`
+  - Added model `InvestigationMetadata`
+  - Added model `InvestigationResult`
+  - Added model `InvestigationScope`
+  - Added model `IssueProperties`
+  - Added model `IssuePropertiesUpdate`
+  - Added model `IssueResource`
+  - Added model `IssueResourceListResult`
+  - Added model `IssueResourceUpdate`
+  - Added model `ListParameter`
+  - Added enum `MetricAlertsDisplayUnit`
+  - Added model `Origin`
+  - Added model `PagedRelatedAlert`
+  - Added model `PagedRelatedResource`
+  - Added model `PrometheusEnrichmentItem`
+  - Added model `PrometheusInstantQuery`
+  - Added model `PrometheusRangeQuery`
+  - Added model `PrometheusRuleGroupResourcePatchParameters`
+  - Added model `ProxyResource`
+  - Added model `ProxyResourceAutoGenerated`
+  - Added model `RelatedAlert`
+  - Added model `RelatedAlerts`
+  - Added model `RelatedResource`
+  - Added model `RelatedResources`
+  - Added enum `Relevance`
+  - Added model `ResourceAutoGenerated2`
+  - Added model `ResourceAutoGenerated3`
+  - Added enum `ResourceProvisioningState`
+  - Added model `RuleArmTemplate`
+  - Added model `RunParameters`
+  - Added model `StartInvestigationParameters`
+  - Added enum `Status`
+  - Added enum `Type`
+  - Model `AlertsOperations` added method `get_enrichments`
+  - Model `AlertsOperations` added method `list_enrichments`
+  - Added model `AlertRuleRecommendationsOperations`
+  - Added model `IssueOperations`
+  - Method `AlertProcessingRulesOperations.create_or_update` has a new overload `def create_or_update(self: None, resource_group_name: str, alert_processing_rule_name: str, alert_processing_rule: IO[bytes], content_type: str)`
+  - Method `AlertProcessingRulesOperations.update` has a new overload `def update(self: None, resource_group_name: str, alert_processing_rule_name: str, alert_processing_rule_patch: IO[bytes], content_type: str)`
+  - Method `AlertsOperations.change_state` has a new overload `def change_state(self: None, scope: str, alert_id: str, new_state: Union[str, AlertState], comment: Optional[Comments], content_type: str)`
+  - Method `AlertsOperations.change_state` has a new overload `def change_state(self: None, scope: str, alert_id: str, new_state: Union[str, AlertState], comment: Optional[IO[bytes]], content_type: str)`
+  - Method `PrometheusRuleGroupsOperations.create_or_update` has a new overload `def create_or_update(self: None, resource_group_name: str, rule_group_name: str, parameters: IO[bytes], content_type: str)`
+  - Method `PrometheusRuleGroupsOperations.update` has a new overload `def update(self: None, resource_group_name: str, rule_group_name: str, parameters: PrometheusRuleGroupResourcePatchParameters, content_type: str)`
+  - Method `PrometheusRuleGroupsOperations.update` has a new overload `def update(self: None, resource_group_name: str, rule_group_name: str, parameters: IO[bytes], content_type: str)`
+  - Method `IssueOperations.add_or_update_alerts` has a new overload `def add_or_update_alerts(self: None, resource_uri: str, body: RelatedAlerts, content_type: str)`
+  - Method `IssueOperations.add_or_update_alerts` has a new overload `def add_or_update_alerts(self: None, resource_uri: str, body: IO[bytes], content_type: str)`
+  - Method `IssueOperations.add_or_update_resources` has a new overload `def add_or_update_resources(self: None, resource_uri: str, body: RelatedResources, content_type: str)`
+  - Method `IssueOperations.add_or_update_resources` has a new overload `def add_or_update_resources(self: None, resource_uri: str, body: IO[bytes], content_type: str)`
+  - Method `IssueOperations.create` has a new overload `def create(self: None, resource_uri: str, resource: IssueResource, content_type: str)`
+  - Method `IssueOperations.create` has a new overload `def create(self: None, resource_uri: str, resource: IO[bytes], content_type: str)`
+  - Method `IssueOperations.fetch_investigation_result` has a new overload `def fetch_investigation_result(self: None, resource_uri: str, body: FetchInvestigationResultParameters, content_type: str)`
+  - Method `IssueOperations.fetch_investigation_result` has a new overload `def fetch_investigation_result(self: None, resource_uri: str, body: IO[bytes], content_type: str)`
+  - Method `IssueOperations.list_alerts` has a new overload `def list_alerts(self: None, resource_uri: str, body: ListParameter, content_type: str)`
+  - Method `IssueOperations.list_alerts` has a new overload `def list_alerts(self: None, resource_uri: str, body: IO[bytes], content_type: str)`
+  - Method `IssueOperations.list_resources` has a new overload `def list_resources(self: None, resource_uri: str, body: ListParameter, content_type: str)`
+  - Method `IssueOperations.list_resources` has a new overload `def list_resources(self: None, resource_uri: str, body: IO[bytes], content_type: str)`
+  - Method `IssueOperations.start_investigation` has a new overload `def start_investigation(self: None, resource_uri: str, body: StartInvestigationParameters, content_type: str)`
+  - Method `IssueOperations.start_investigation` has a new overload `def start_investigation(self: None, resource_uri: str, body: IO[bytes], content_type: str)`
+  - Method `IssueOperations.update` has a new overload `def update(self: None, resource_uri: str, properties: IssueResourceUpdate, content_type: str)`
+  - Method `IssueOperations.update` has a new overload `def update(self: None, resource_uri: str, properties: IO[bytes], content_type: str)`
+
+### Breaking Changes
+
+  - Method `AlertsManagementClient.__init__` inserted a `positional_or_keyword` parameter `issue_name`
+  - Model `ResourceAutoGenerated` deleted or renamed its instance variable `system_data`
+  - Deleted or renamed model `PrometheusRuleGroupResourcePatch`
+  - Deleted or renamed model `PrometheusRuleGroupResourcePatchProperties`
+  - Method `AlertsOperations.change_state` inserted a `positional_or_keyword` parameter `scope`
+  - Method `AlertsOperations.get_all` inserted a `positional_or_keyword` parameter `scope`
+  - Method `AlertsOperations.get_by_id` inserted a `positional_or_keyword` parameter `scope`
+  - Method `AlertsOperations.get_history` inserted a `positional_or_keyword` parameter `scope`
+  - Method `AlertsOperations.get_summary` inserted a `positional_or_keyword` parameter `scope`
+
 ## 2.0.0b2 (2022-12-26)
 
 ### Features Added

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

@@ -1,28 +1,61 @@
 # Microsoft Azure SDK for Python
 
 This is the Microsoft Azure Alerts Management Client Library.
-This package has been tested with Python 3.7+.
+This package has been tested with Python 3.8+.
 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_
 
-# Usage
+## Getting started
 
+### Prerequisites
 
-To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt)
-
-For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/)
-Code samples for this package can be found at [Alerts Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
-Additional code samples for different Azure services are available at [Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
+- Python 3.8+ is required to use this package.
+- [Azure subscription](https://azure.microsoft.com/free/)
 
+### Install the package
 
-# Provide Feedback
+```bash
+pip install azure-mgmt-alertsmanagement
+pip install azure-identity
+```
 
-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. 
+### Authentication
+
+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.
+- `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.alertsmanagement import AlertsManagementClient
+import os
 
+sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
+client = AlertsManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
+```
 
+## Examples
 
+Code samples for this package can be found at:
+- [Search Alerts 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. 

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

@@ -1,11 +1,11 @@
 {
-  "commit": "e37a57df67daaa82f9c3758fc450bc8655812a08",
+  "commit": "4e7ecd6a2256b6d3ea5865b80d633f0b8e032456",
   "repository_url": "https://github.com/Azure/azure-rest-api-specs",
-  "autorest": "3.9.2",
+  "autorest": "3.10.2",
   "use": [
-    "@autorest/python@6.2.7",
-    "@autorest/modelerfour@4.24.3"
+    "@autorest/python@6.27.4",
+    "@autorest/modelerfour@4.27.0"
   ],
-  "autorest_command": "autorest specification/alertsmanagement/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.2.7 --use=@autorest/modelerfour@4.24.3 --version=3.9.2 --version-tolerant=False",
+  "autorest_command": "autorest specification/alertsmanagement/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.27.4 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False",
   "readme": "specification/alertsmanagement/resource-manager/readme.md"
 }

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

@@ -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 ._alerts_management_client import AlertsManagementClient
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._alerts_management_client import AlertsManagementClient  # 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__ = [
     "AlertsManagementClient",
 ]
-__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()

sdk/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement/_alerts_management_client.py

@@ -8,32 +8,33 @@
 
 from copy import deepcopy
 from typing import Any, TYPE_CHECKING
+from typing_extensions import Self
 
+from azure.core.pipeline import policies
 from azure.core.rest import HttpRequest, HttpResponse
 from azure.mgmt.core import ARMPipelineClient
+from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
 
 from . import models as _models
 from ._configuration import AlertsManagementClientConfiguration
 from ._serialization import Deserializer, Serializer
 from .operations import (
     AlertProcessingRulesOperations,
+    AlertRuleRecommendationsOperations,
     AlertsOperations,
+    IssueOperations,
     Operations,
     PrometheusRuleGroupsOperations,
     SmartGroupsOperations,
 )
 
 if TYPE_CHECKING:
-    # pylint: disable=unused-import,ungrouped-imports
     from azure.core.credentials import TokenCredential
 
 
-class AlertsManagementClient:  # pylint: disable=client-accepts-api-version-keyword
+class AlertsManagementClient:  # pylint: disable=client-accepts-api-version-keyword,too-many-instance-attributes
     """AlertsManagement Client.
 
-    :ivar alert_processing_rules: AlertProcessingRulesOperations operations
-    :vartype alert_processing_rules:
-     azure.mgmt.alertsmanagement.operations.AlertProcessingRulesOperations
     :ivar prometheus_rule_groups: PrometheusRuleGroupsOperations operations
     :vartype prometheus_rule_groups:
      azure.mgmt.alertsmanagement.operations.PrometheusRuleGroupsOperations
@@ -43,8 +44,18 @@ class AlertsManagementClient:  # pylint: disable=client-accepts-api-version-keyw
     :vartype alerts: azure.mgmt.alertsmanagement.operations.AlertsOperations
     :ivar smart_groups: SmartGroupsOperations operations
     :vartype smart_groups: azure.mgmt.alertsmanagement.operations.SmartGroupsOperations
+    :ivar alert_rule_recommendations: AlertRuleRecommendationsOperations operations
+    :vartype alert_rule_recommendations:
+     azure.mgmt.alertsmanagement.operations.AlertRuleRecommendationsOperations
+    :ivar alert_processing_rules: AlertProcessingRulesOperations operations
+    :vartype alert_processing_rules:
+     azure.mgmt.alertsmanagement.operations.AlertProcessingRulesOperations
+    :ivar issue: IssueOperations operations
+    :vartype issue: azure.mgmt.alertsmanagement.operations.IssueOperations
     :param credential: Credential needed for the client to connect to Azure. Required.
     :type credential: ~azure.core.credentials.TokenCredential
+    :param issue_name: The name of the IssueResource. Required.
+    :type issue_name: str
     :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".
@@ -54,30 +65,53 @@ class AlertsManagementClient:  # pylint: disable=client-accepts-api-version-keyw
     def __init__(
         self,
         credential: "TokenCredential",
+        issue_name: str,
         subscription_id: str,
         base_url: str = "https://management.azure.com",
         **kwargs: Any
     ) -> None:
         self._config = AlertsManagementClientConfiguration(
-            credential=credential, subscription_id=subscription_id, **kwargs
+            credential=credential, issue_name=issue_name, subscription_id=subscription_id, **kwargs
         )
-        self._client = ARMPipelineClient(base_url=base_url, config=self._config, **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=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.alert_processing_rules = AlertProcessingRulesOperations(
-            self._client, self._config, self._serialize, self._deserialize
-        )
         self.prometheus_rule_groups = PrometheusRuleGroupsOperations(
             self._client, self._config, self._serialize, self._deserialize
         )
         self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)
         self.alerts = AlertsOperations(self._client, self._config, self._serialize, self._deserialize)
         self.smart_groups = SmartGroupsOperations(self._client, self._config, self._serialize, self._deserialize)
+        self.alert_rule_recommendations = AlertRuleRecommendationsOperations(
+            self._client, self._config, self._serialize, self._deserialize
+        )
+        self.alert_processing_rules = AlertProcessingRulesOperations(
+            self._client, self._config, self._serialize, self._deserialize
+        )
+        self.issue = IssueOperations(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
@@ -97,14 +131,14 @@ 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) -> "AlertsManagementClient":
+    def __enter__(self) -> Self:
         self._client.__enter__()
         return self
 
-    def __exit__(self, *exc_details) -> None:
+    def __exit__(self, *exc_details: Any) -> None:
         self._client.__exit__(*exc_details)