dsccommunity / dsccommunity/SqlServerDsc

SqlDatabaseApplicationRole: New resource proposal

Open
#1,557 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted resource proposal
Dominant language
PowerShell
Stars
385
Forks
224
PR merge metrics
No merged PRs in 30d

Description

Description

Suggest adding a new resource that manages an application role in a database.

Proposed properties
[ClassVersion("1.0.0.0"), FriendlyName("SqlDatabaseApplicationRole")]
class DSC_SqlDatabaseApplicationRole : OMI_BaseResource
{
    [Key, Description("Specifies the name of the SQL instance to be configured.")] String InstanceName;
    [Key, Description("Specifies the name of the database in which the application role should be configured.")] String DatabaseName;
    [Key, Description("Specifies the name of the database application role to be added or removed.")] String Name;
    [Write, EmbeddedInstance("MSFT_Credential"), Description("Specifies the password for the application role.")] String Password;
    [Write, Description("Specifies the host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;
    [Write, Description("Specifies if the application role should be present or absent in the database. The default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
    [Write, Description("Specifies the default schema for the application role.")] String DefaultSchema;
    [Write, Description("When set to to $true the Test-function will always return $false and the password will be changed.")] Boolean Force;
};
Special considerations or limitations

There is no way to access the password what I have seen, so there is no way of determine if the password need changing. Proposed a Force parameter, but that would make the resource always set the password every time the values are enforced. Best option might be just to just set the password on creating and then the application role must be removed for the password to change.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No implementation files or tests are named. Start by reviewing the repository's existing SQL Server DSC resources and determine how the proposed properties map to resource conventions, especially application-role password handling; done means an agreed design and a tested resource that manages the requested role state.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, sql
Domain
database
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.