dsccommunity / dsccommunity/SqlServerDsc
SqlAgentAlert: Resource refactoring proposal
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 385
- Forks
- 224
- PR merge metrics
- No merged PRs in 30d
Description
Resource proposal
A class-based SqlAgentAlert resource would manage SQL Server Agent alerts, ensuring specific alerts exist or are absent. It would use Test-SqlDscAgentAlert and relevant creation/removal commands.
Proposed properties
| Property | Type qualifier | Data type | Description | Default value | Allowed values |
|---|---|---|---|---|---|
| Ensure | Key | String | Whether the alert should be Present or Absent | Present | Present, Absent |
| AlertName | Key | String | Name of the agent alert | None | Any valid alert name |
| DatabaseName | Write | String | Database associated with the alert | None | Any valid database name |
| ServerName | Key | String | The SQL Server host name | None | Any valid server name |
| InstanceName | Key | String | The SQL Server instance name | None | Any valid instance name |
Special considerations or limitations
Should support all alert types, ensure proper idempotency, and validate alert conditions. Contributors should ensure proper permissions and handle version-specific alert options.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating Test-SqlDscAgentAlert and the relevant SQL Server Agent alert creation and removal commands in the repository. Determine how all alert types, idempotency, alert-condition validation, permissions, and version-specific options are handled; done means a class-based SqlAgentAlert resource supports the proposed properties and these requirements.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, sql
- Domain
- databases, infrastructure
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100