< Back
New-DbaDbRole
Post
NAME New-DbaDbRole
SYNOPSIS
Create new database roles for each database(s)/ instance(s) of SQL Server.
SYNTAX
New-DbaDbRole [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [[-Role] <System.String[]>]
[[-Owner] <String>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
The New-DbaDbRole create new roles on database(s)/ instance(s) of SQL Server.
PARAMETERS
-Database [<System.String[]>]
The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be
processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDatabase [<System.String[]>]
The database(s) to exclude - this list is auto-populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
Enables piped input from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Owner [<String>]
The owner of the role. If not specified will assume the default dbo.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Role [<System.String[]>]
The role(s) to create.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Role, Database, Security
Author: Cl????????udio Silva (@ClaudioESSilva), https://claudioessilva.eu
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaDbRole -SqlInstance sql2017a -Database db1 -Role 'dbExecuter'
Will create a new role named dbExecuter within db1 on sql2017a instance.
RELATED LINKS
https://dbatools.io/New-DbaDbRole
SYNOPSIS
Create new database roles for each database(s)/ instance(s) of SQL Server.
SYNTAX
New-DbaDbRole [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [[-Role] <System.String[]>]
[[-Owner] <String>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
The New-DbaDbRole create new roles on database(s)/ instance(s) of SQL Server.
PARAMETERS
-Database [<System.String[]>]
The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be
processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDatabase [<System.String[]>]
The database(s) to exclude - this list is auto-populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
Enables piped input from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Owner [<String>]
The owner of the role. If not specified will assume the default dbo.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Role [<System.String[]>]
The role(s) to create.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Role, Database, Security
Author: Cl????????udio Silva (@ClaudioESSilva), https://claudioessilva.eu
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaDbRole -SqlInstance sql2017a -Database db1 -Role 'dbExecuter'
Will create a new role named dbExecuter within db1 on sql2017a instance.
RELATED LINKS
https://dbatools.io/New-DbaDbRole