Azure / Azure/azure-sdk-for-net

docs: improve Azure.Provisioning.Monitor README with resource types and next steps

Open
#57,765 0 comments 0 reactions 1 assignee Claimed by @ArthurMa1978 View on GitHub
Monitor Provisioning
Dominant language
C#
Stars
6.1k
Forks
5.2k
Avg merge
1d 16h
Merged PRs (30d)
407

Description

## Summary

Improves the `Azure.Provisioning.Monitor` README (introduced in #57725) to fill two documentation gaps:

### Changes

**Key concepts — supported resource types table**

The `## Key concepts` section previously had only a single boilerplate sentence. Users discovering the library had no way to know what Azure Monitor resources were available without reading the generated API. A table of all 16 `ProvisionableResource` types with brief descriptions has been added:

| Resource | Description |
|---|---|
| `ActionGroup` | Defines a set of notification actions triggered by alerts |
| `ActivityLogAlert` | Creates alerts based on Azure activity log events |
| `AlertRule` | Classic metric alert rule for Azure Monitor metrics |
| `AutoscaleSetting` | Configures automatic scaling of compute resources |
| `DataCollectionEndpoint` | Defines an endpoint for data collection pipelines |
| `DataCollectionRule` | Specifies how data is collected and routed to destinations |
| `DataCollectionRuleAssociation` | Associates a data collection rule with a monitored resource |
| `DiagnosticSetting` | Routes diagnostic logs and metrics to storage, event hubs, or Log Analytics |
| `LogProfile` | Classic log profile for routing activity logs (legacy) |
| `MetricAlert` | Creates alerts based on Azure Monitor metric thresholds or dynamic conditions |
| `MonitorPrivateEndpointConnection` | Manages private endpoint connections for Azure Monitor Private Link |
| `MonitorPrivateLinkScope` | Defines the scope of a Private Link configuration for Azure Monitor |
| `MonitorPrivateLinkScoped` | Associates resources with a Monitor Private Link scope |
| `MonitorWorkspace` | Azure Monitor workspace for storing Prometheus metrics |
| `PipelineGroup` | Groups data collection pipelines for centralized management |
| `ScheduledQueryRule` | Creates alerts based on Log Analytics or metrics queries |

**Next steps — useful links**

The `## Next steps` section was entirely empty. Three links were added:
- Azure Monitor overview documentation
- Azure Developer CLI getting-started guide (for `azd` deployments)
- Azure Monitor quickstart templates on GitHub

### No behavior changes

Documentation-only change; no code was modified.

### Reviewers

cc `@ArcturusZhang` `@ArthurMa1978` `@m-nash` (Azure.Provisioning CODEOWNERS)

> Generated by [Update Docs](https://github.com/Azure/azure-sdk-for-net/actions/runs/23939790158/agentic_workflow) · [◷](https://github.com/search?q=repo%3AAzure%2Fazure-sdk-for-net+%22gh-aw-workflow-id%3A+update-samples-and-docs%22&type=pullrequests)

---

> [!NOTE]
> This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
> The changes have been pushed to branch `docs/azure-provisioning-monitor-readme-improvements-386d100ba96aaa09`.
>
> **[Click here to create the pull request](https://github.com/Azure/azure-sdk-for-net/compare/main...docs/azure-provisioning-monitor-readme-improvements-386d100ba96aaa09?expand=1&title=docs%3A%20improve%20Azure.Provisioning.Monitor%20README%20with%20resource%20types%20and%20next%20steps)**

To fix the permissions issue, go to **Settings** → **Actions** → **General** and enable **Allow GitHub Actions to create and approve pull requests**. See also: [gh-aw FAQ](https://github.github.com/gh-aw/reference/faq/#why-is-my-create-pull-request-workflow-failing-with-github-actions-is-not-permitted-to-create-or-approve-pull-requests)

Show patch preview (73 of 73 lines)

```diff
From 642d787ce53ecc47895c292a5095f9fa2c2fd760 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
Date: Fri, 3 Apr 2026 08:40:14 +0000
Subject: [PATCH] docs: improve Azure.Provisioning.Monitor README with resource
types and next steps

- Add table of all 16 supported resource types with descriptions in Key concepts
- Fill in the empty Next steps section with links to Azure Monitor docs,
Azure Developer CLI, and quickstart templates

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
.../Azure.Provisioning.Monitor/README.md | 30 ++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/sdk/monitor/Azure.Provisioning.Monitor/README.md b/sdk/monitor/Azure.Provisioning.Monitor/README.md
index 6dc8ddd70..bbe729e83 100644
--- a/sdk/monitor/Azure.Provisioning.Monitor/README.md
+++ b/sdk/monitor/Azure.Provisioning.Monitor/README.md
@@ -22,6 +22,27 @@ dotnet add package Azure.Provisioning.Monitor --prerelease

This library allows you to specify your infrastructure in a declarative style using dotnet. You can then use azd to deploy your infrastructure to Azure directly without needing to write or maintain bicep or arm templates.

+The following Azure Monitor resource types are supported:
+
+| Resource | Description |
+|---|---|
+| `ActionGroup` | Defines a set of notification actions triggered by alerts |
+| `ActivityLogAlert` | Creates alerts based on Azure activity log events (e.g., service health, resource changes) |
+| `AlertRule` | Classic metric alert rule for Azure Monitor metrics |
+| `AutoscaleSetting` | Configures automatic scaling of compute resources based on metrics |
+| `DataCollectionEndpoint` | Defines an endpoint for data collection pipelines |
+| `DataCollectionRule` | Specifies how data is collected and routed to destinations |
+| `DataCollectionRuleAssociation` | Associates a data collection rule with a monitored resource |
+| `DiagnosticSetting` | R
... (truncated)
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.