Skip to content

[AutoPR azure-mgmt-alertsmanagement] Added new PreviewAlertRule API #10151

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

## 2.0.0b3 (2025-05-13)

### Features Added

- Client `AlertsManagementClient` added method `preview_alert_rule`
- Client `AlertsManagementClient` added operation group `alert_rule_recommendations`
- Client `AlertsManagementClient` added operation group `issue`
- Enum `AlertState` added member `FIRED`
- Enum `AlertState` added member `FIRING`
- Enum `AlertState` added member `NO_ALERT`
- Enum `AlertState` added member `RESOLVED`
- Enum `AlertState` added member `RESOLVING`
- 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 model `AbnormalEventAnomalyInsight`
- Added model `AbnormalEventData`
- Added model `AbnormalEventDetails`
- Added enum `AbnormalEventType`
- Added enum `AddedByType`
- Added enum `AggregationType`
- Added model `AlertEnrichmentItem`
- Added model `AlertEnrichmentProperties`
- Added model `AlertEnrichmentResponse`
- Added model `AlertEnrichmentsList`
- Added model `AlertRuleRecommendationResource`
- Added model `AlertRuleRecommendationsListResponse`
- Added enum `AlertSeverity`
- Added enum `AnomalyDirection`
- Added model `AnomalyRange`
- Added enum `AvailabilityState`
- Added model `AzureMetricAnomalyInsight`
- Added model `AzureMetricData`
- Added model `AzureMetricDetails`
- Added model `BaselineRange`
- Added enum `CategoryType`
- Added enum `ConditionOperator`
- Added model `CorrelationDetails`
- Added enum `CriterionType`
- Added model `DetailsBase`
- Added enum `DetailsType`
- Added model `DiagnosticsInsight`
- Added model `DiagnosticsSolutionDetails`
- Added model `DimensionNameAndValue`
- Added enum `DimensionOperator`
- Added model `ErrorDetailAutoGenerated`
- Added model `ErrorDetailAutoGenerated2`
- Added model `ErrorResponseAutoGenerated4`
- Added model `ErrorResponseAutoGenerated5`
- Added model `EvaluatedPeriod`
- Added model `Evaluation`
- Added model `ExceptionPatternAnomaly`
- Added model `FetchInvestigationResultParameters`
- Added enum `HealthState`
- Added model `InvestigationDetails`
- Added model `InvestigationEntity`
- 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 enum `Kind`
- Added model `ListParameter`
- Added model `LogAlertRuleCondition`
- Added model `LogAlertRuleConditionFailingPeriods`
- Added model `LogAlertRuleCriteria`
- Added model `LogAlertRuleDimension`
- Added model `LogAlertRuleResolveConfiguration`
- Added model `LogAlertRuleResource`
- Added model `LogAlertRuleUserIdentityProperties`
- Added enum `MetricAlertsDisplayUnit`
- Added model `Origin`
- Added model `PagedRelatedAlert`
- Added model `PagedRelatedResource`
- Added model `PreviewAlertRuleRequest`
- Added model `PreviewAlertRuleRequestProperties`
- Added model `PreviewAlertRuleResponse`
- Added model `PrometheusEnrichmentItem`
- Added model `PrometheusInstantQuery`
- Added model `PrometheusRangeQuery`
- Added model `PrometheusRuleGroupResourcePatchParameters`
- Added model `ProxyResource`
- Added model `ProxyResourceAutoGenerated`
- Added model `RelatedAlert`
- Added model `RelatedAlertAnomalyInsight`
- Added model `RelatedAlertData`
- Added model `RelatedAlertDetails`
- Added model `RelatedAlerts`
- Added model `RelatedResource`
- Added model `RelatedResources`
- Added enum `Relevance`
- Added model `ResourceAutoGenerated2`
- Added model `ResourceAutoGenerated3`
- Added model `ResourceHealthDetails`
- Added model `ResourceHealthInsight`
- Added enum `ResourceProvisioningState`
- Added model `RuleArmTemplate`
- Added model `RulePreviewResult`
- Added model `RunParameters`
- Added model `StartInvestigationParameters`
- Added enum `Status`
- Added model `Summary`
- Added enum `TimeAggregation`
- Added model `TracePatternAnomaly`
- Added model `TransactionEdge`
- Added model `TransactionNode`
- Added model `TransactionPatternAnomaly`
- Added enum `Type`
- Model `AlertsOperations` added method `get_enrichments`
- Model `AlertsOperations` added method `list_enrichments`
- Added model `AlertRuleRecommendationsOperations`
- Added model `AlertsManagementClientOperationsMixin`
- Added model `IssueOperations`
- Method `AlertsManagementClient.preview_alert_rule` has a new overload `def preview_alert_rule(self: None, parameters: PreviewAlertRuleRequest, content_type: str)`
- Method `AlertsManagementClient.preview_alert_rule` has a new overload `def preview_alert_rule(self: None, parameters: IO[bytes], content_type: str)`
- 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 `AlertsManagementClientOperationsMixin.preview_alert_rule` has a new overload `def preview_alert_rule(self: None, parameters: PreviewAlertRuleRequest, content_type: str)`
- Method `AlertsManagementClientOperationsMixin.preview_alert_rule` has a new overload `def preview_alert_rule(self: None, 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
Expand Down
55 changes: 44 additions & 11 deletions sdk/alertsmanagement/azure-mgmt-alertsmanagement/README.md
Original file line number Diff line number Diff line change
@@ -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.9+.
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.9+ 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.
10 changes: 5 additions & 5 deletions sdk/alertsmanagement/azure-mgmt-alertsmanagement/_meta.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"commit": "e37a57df67daaa82f9c3758fc450bc8655812a08",
"commit": "6b632b979e210aad99b0050050d63f1539b50ad3",
"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.34.1",
"@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.34.1 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False",
"readme": "specification/alertsmanagement/resource-manager/readme.md"
}
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 ._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()
Loading