Resource Type: dsc_sqldatabaserole

Properties

dsc_databaseisupdateable

Returns if the database is updatable. If the database is updatable, this will return ‘$true`. Otherwise it will return `$false`.
dsc_ensure

If ‘’Present’‘ then the role will be added to the database and the role membership will be set. If `’Absent’‘ then the role will be removed from the database. Default value is `’Present’‘.
dsc_members

The members the database role should have. This parameter will replace all the current database role members with the specified members. Will only be used when parameter Ensure is set to ‘’Present’‘.
dsc_membersindesiredstate

Returns whether the database role members are in the desired state.
dsc_memberstoexclude

The members the database role should exclude. This parameter will only remove members from a database role. Will only be used when parameter Ensure is set to ‘’Present’‘. Can not be used at the same time as parameter Members.
dsc_memberstoinclude

The members the database role should include. This parameter will only add members to a database role. Will only be used when parameter Ensure is set to ‘’Present’‘. Can not be used at the same time as parameter Members.
dsc_servername

The host name of the _SQL Server_ to be configured. Default value is the current computer name.

Parameters

dsc_databasename (namevar)

The name of the database in which the role should be configured.
dsc_instancename (namevar)

The name of the _SQL Server_ instance to be configured.
dsc_name (namevar)

The name of the database role to be added or removed.
dsc_psdscrunascredential
dsc_timeout

The maximum time in seconds to wait for the DSC resource to complete.
name (namevar)

Description of the purpose for this resource declaration.
validation_mode (defaults to: property)

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Overview