functions/Export-DbaUser.ps1
|
function Export-DbaUser { <# .SYNOPSIS Exports users creation and its permissions to a T-SQL file or host. .DESCRIPTION Exports users creation and its permissions to a T-SQL file or host. Export includes user, create and add to role(s), database level permissions, object level permissions. .PARAMETER SqlInstance The target SQL Server instance or instances. SQL Server 2000 and above supported. .PARAMETER SqlCredential 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. .PARAMETER Database The database(s) to process - this list is auto-populated from the server. If unspecified, all InputObject will be processed. .PARAMETER ExcludeDatabase The database(s) to exclude - this list is auto-populated from the server .PARAMETER User Export only the specified database user(s). If not specified will export all users from the database(s) .PARAMETER DestinationVersion To say to which version the script should be generated. If not specified will use database compatibility level .PARAMETER Path Specifies the directory where the file or files will be exported. .PARAMETER FilePath Specifies the full file path of the output file. .PARAMETER InputObject Allows database objects to be piped in from Get-DbaDatabase .PARAMETER NoClobber Do not overwrite file .PARAMETER Append Append to file .PARAMETER Passthru Output script to console, useful with | clip .PARAMETER WhatIf Shows what would happen if the command were to run. No actions are actually performed. .PARAMETER Confirm Prompts you for confirmation before executing any changing operations within the command. .PARAMETER EnableException 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. .PARAMETER ScriptingOptionsObject A Microsoft.SqlServer.Management.Smo.ScriptingOptions object with the options that you want to use to generate the t-sql script. You can use the NEw-DbaScriptingOption to generate it. .PARAMETER ExcludeGoBatchSeparator If specified, will NOT script the 'GO' batch separator. .NOTES Tags: User, Export Author: Claudio Silva (@ClaudioESSilva) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Export-DbaUser .EXAMPLE PS C:\> Export-DbaUser -SqlInstance sql2005 -FilePath C:\temp\sql2005-users.sql Exports SQL for the users in server "sql2005" and writes them to the file "C:\temp\sql2005-users.sql" .EXAMPLE PS C:\> Export-DbaUser -SqlInstance sqlserver2014a $scred -FilePath C:\temp\users.sql -Append Authenticates to sqlserver2014a using SQL Authentication. Exports all users to C:\temp\users.sql, and appends to the file if it exists. If not, the file will be created. .EXAMPLE PS C:\> Export-DbaUser -SqlInstance sqlserver2014a -User User1, User2 -FilePath C:\temp\users.sql Exports ONLY users User1 and User2 from sqlserver2014a to the file C:\temp\users.sql .EXAMPLE PS C:\> Export-DbaUser -SqlInstance sqlserver2014a -User User1, User2 -Path C:\temp Exports ONLY users User1 and User2 from sqlserver2014a to the folder C:\temp. One file per user will be generated .EXAMPLE PS C:\> Export-DbaUser -SqlInstance sqlserver2008 -User User1 -FilePath C:\temp\users.sql -DestinationVersion SQLServer2016 Exports user User1 from sqlserver2008 to the file C:\temp\users.sql with syntax to run on SQL Server 2016 .EXAMPLE PS C:\> Export-DbaUser -SqlInstance sqlserver2008 -Database db1,db2 -FilePath C:\temp\users.sql Exports ONLY users from db1 and db2 database on sqlserver2008 server, to the C:\temp\users.sql file. .EXAMPLE PS C:\> $options = New-DbaScriptingOption PS C:\> $options.ScriptDrops = $false PS C:\> $options.WithDependencies = $true PS C:\> Export-DbaUser -SqlInstance sqlserver2008 -Database db1,db2 -FilePath C:\temp\users.sql -ScriptingOptionsObject $options Exports ONLY users from db1 and db2 database on sqlserver2008 server, to the C:\temp\users.sql file. It will not script drops but will script dependencies. .EXAMPLE PS C:\> Export-DbaUser -SqlInstance sqlserver2008 -Database db1,db2 -FilePath C:\temp\users.sql -ExcludeGoBatchSeparator Exports ONLY users from db1 and db2 database on sqlserver2008 server, to the C:\temp\users.sql file without the 'GO' batch separator. #> [CmdletBinding(DefaultParameterSetName = "Default")] [OutputType([String])] param ( [parameter(ValueFromPipeline)] [DbaInstanceParameter[]]$SqlInstance, [parameter(ValueFromPipeline)] [Microsoft.SqlServer.Management.Smo.Database[]]$InputObject, [PSCredential]$SqlCredential, [string[]]$Database, [string[]]$ExcludeDatabase, [string[]]$User, [ValidateSet('SQLServer2000', 'SQLServer2005', 'SQLServer2008/2008R2', 'SQLServer2012', 'SQLServer2014', 'SQLServer2016', 'SQLServer2017')] [string]$DestinationVersion, [string]$Path = (Get-DbatoolsConfigValue -FullName 'Path.DbatoolsExport'), [Alias("OutFile", "FileName")] [string]$FilePath, [Alias("NoOverwrite")] [switch]$NoClobber, [switch]$Append, [switch]$Passthru, [switch]$EnableException, [Microsoft.SqlServer.Management.Smo.ScriptingOptions]$ScriptingOptionsObject = $null, [switch]$ExcludeGoBatchSeparator ) begin { $null = Test-ExportDirectory -Path $Path $outsql = $script:pathcollection = @() $GenerateFilePerUser = $false $versions = @{ 'SQLServer2000' = 'Version80' 'SQLServer2005' = 'Version90' 'SQLServer2008/2008R2' = 'Version100' 'SQLServer2012' = 'Version110' 'SQLServer2014' = 'Version120' 'SQLServer2016' = 'Version130' 'SQLServer2017' = 'Version140' } $versionName = @{ 'Version80' = 'SQLServer2000' 'Version90' = 'SQLServer2005' 'Version100' = 'SQLServer2008/2008R2' 'Version110' = 'SQLServer2012' 'Version120' = 'SQLServer2014' 'Version130' = 'SQLServer2016' 'Version140' = 'SQLServer2017' } } process { if (Test-FunctionInterrupt) { return } foreach ($instance in $SqlInstance) { $InputObject += Get-DbaDatabase -SqlInstance $instance -SqlCredential $SqlCredential -Database $Database -ExcludeDatabase $ExcludeDatabase } # To keep the filenames generated and re-use (appedn) if needed $usersProcessed = @{ } foreach ($db in $InputObject) { if ([string]::IsNullOrEmpty($destinationVersion)) { #Get compatibility level for scripting the objects $scriptVersion = $db.CompatibilityLevel } else { $scriptVersion = $versions[$destinationVersion] } $versionNameDesc = $versionName[$scriptVersion.ToString()] #If not passed create new ScriptingOption. Otherwise use the one that was passed if ($null -eq $ScriptingOptionsObject) { $ScriptingOptionsObject = New-DbaScriptingOption $ScriptingOptionsObject.TargetServerVersion = [Microsoft.SqlServer.Management.Smo.SqlServerVersion]::$scriptVersion $ScriptingOptionsObject.AllowSystemObjects = $false $ScriptingOptionsObject.IncludeDatabaseRoleMemberships = $true $ScriptingOptionsObject.ContinueScriptingOnError = $false $ScriptingOptionsObject.IncludeDatabaseContext = $false $ScriptingOptionsObject.IncludeIfNotExists = $true } Write-Message -Level Verbose -Message "Validating users on database $db" if ($User) { $users = $db.Users | Where-Object { $User -contains $_.Name -and $_.IsSystemObject -eq $false -and $_.Name -notlike "##*" } } else { $users = $db.Users } # Generate the file path if (Test-Bound -ParameterName FilePath -Not) { $GenerateFilePerUser = $true } else { # Generate a new file name with passed/default path $FilePath = Get-ExportFilePath -Path $PSBoundParameters.Path -FilePath $PSBoundParameters.FilePath -Type sql -ServerName $db.Parent.Name -Unique # Force append to have everything on same file $Append = $true } # Store roles between users so if we hit the same one we don't create it again $roles = @() $stepCounter = 0 foreach ($dbuser in $users) { if ($GenerateFilePerUser) { if ($null -eq $usersProcessed[$dbuser.Name]) { # If user and not specific output file, create file name without database name. $FilePath = Get-ExportFilePath -Path $PSBoundParameters.Path -FilePath $PSBoundParameters.FilePath -Type sql -ServerName $("$($db.Parent.Name)-$($dbuser.Name)") -Unique $usersProcessed[$dbuser.Name] = $FilePath } else { $Append = $true $FilePath = $usersProcessed[$dbuser.Name] } } Write-ProgressHelper -TotalSteps $users.Count -Activity "Exporting from $($db.Name)" -StepNumber ($stepCounter++) -Message "Generating script ($FilePath) for user $dbuser" #setting database if (((Test-Bound ScriptingOptionsObject) -and $ScriptingOptionsObject.IncludeDatabaseContext) -or - (Test-Bound ScriptingOptionsObject -Not)) { $useDatabase = "USE [" + $db.Name + "]" } try { #Fixed Roles #Dependency Issue. Create Role, before add to role. foreach ($rolePermission in ($db.Roles | Where-Object { $_.IsFixedRole -eq $false })) { foreach ($rolePermissionScript in $rolePermission.Script($ScriptingOptionsObject)) { if ($rolePermission.ToString() -notin $roles) { $roles += , $rolePermission.ToString() $outsql += "$($rolePermissionScript.ToString())" } } } #Database Create User(s) and add to Role(s) foreach ($dbUserPermissionScript in $dbuser.Script($ScriptingOptionsObject)) { if ($dbuserPermissionScript.Contains("sp_addrolemember")) { $execute = "EXEC " } else { $execute = "" } $outsql += "$execute$($dbUserPermissionScript.ToString())" } #Database Permissions foreach ($databasePermission in $db.EnumDatabasePermissions() | Where-Object { @("sa", "dbo", "information_schema", "sys") -notcontains $_.Grantee -and $_.Grantee -notlike "##*" -and ($dbuser.Name -contains $_.Grantee) }) { if ($databasePermission.PermissionState -eq "GrantWithGrant") { $withGrant = " WITH GRANT OPTION" $grantDatabasePermission = 'GRANT' } else { $withGrant = " " $grantDatabasePermission = $databasePermission.PermissionState.ToString().ToUpper() } $outsql += "$($grantDatabasePermission) $($databasePermission.PermissionType) TO [$($databasePermission.Grantee)]$withGrant AS [$($databasePermission.Grantor)];" } #Database Object Permissions # NB: This is a bit of a mess for a couple of reasons # 1. $db.EnumObjectPermissions() doesn't enumerate all object types # 2. Some (x)Collection types can have EnumObjectPermissions() called # on them directly (e.g. AssemblyCollection); others can't (e.g. # ApplicationRoleCollection). Those that can't we iterate the # collection explicitly and add each object's permission. $perms = New-Object System.Collections.ArrayList $null = $perms.AddRange($db.EnumObjectPermissions($dbuser.Name)) foreach ($item in $db.ApplicationRoles) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.Assemblies) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.Certificates) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.DatabaseRoles) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.FullTextCatalogs) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.FullTextStopLists) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.SearchPropertyLists) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.ServiceBroker.MessageTypes) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.RemoteServiceBindings) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.ServiceBroker.Routes) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.ServiceBroker.ServiceContracts) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.ServiceBroker.Services) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } if ($scriptVersion -ne "Version80") { foreach ($item in $db.AsymmetricKeys) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } } foreach ($item in $db.SymmetricKeys) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($item in $db.XmlSchemaCollections) { $null = $perms.AddRange($item.EnumObjectPermissions($dbuser.Name)) } foreach ($objectPermission in $perms | Where-Object { @("sa", "dbo", "information_schema", "sys") -notcontains $_.Grantee -and $_.Grantee -notlike "##*" -and $_.Grantee -eq $dbuser.Name }) { switch ($objectPermission.ObjectClass) { 'ApplicationRole' { $object = 'APPLICATION ROLE::[{0}]' -f $objectPermission.ObjectName } 'AsymmetricKey' { $object = 'ASYMMETRIC KEY::[{0}]' -f $objectPermission.ObjectName } 'Certificate' { $object = 'CERTIFICATE::[{0}]' -f $objectPermission.ObjectName } 'DatabaseRole' { $object = 'ROLE::[{0}]' -f $objectPermission.ObjectName } 'FullTextCatalog' { $object = 'FULLTEXT CATALOG::[{0}]' -f $objectPermission.ObjectName } 'FullTextStopList' { $object = 'FULLTEXT STOPLIST::[{0}]' -f $objectPermission.ObjectName } 'MessageType' { $object = 'Message Type::[{0}]' -f $objectPermission.ObjectName } 'ObjectOrColumn' { if ($scriptVersion -ne "Version80") { $object = 'OBJECT::[{0}].[{1}]' -f $objectPermission.ObjectSchema, $objectPermission.ObjectName if ($null -ne $objectPermission.ColumnName) { $object += '([{0}])' -f $objectPermission.ColumnName } } #At SQL Server 2000 OBJECT did not exists else { $object = '[{0}].[{1}]' -f $objectPermission.ObjectSchema, $objectPermission.ObjectName } } 'RemoteServiceBinding' { $object = 'REMOTE SERVICE BINDING::[{0}]' -f $objectPermission.ObjectName } 'Schema' { $object = 'SCHEMA::[{0}]' -f $objectPermission.ObjectName } 'SearchPropertyList' { $object = 'SEARCH PROPERTY LIST::[{0}]' -f $objectPermission.ObjectName } 'Service' { $object = 'SERVICE::[{0}]' -f $objectPermission.ObjectName } 'ServiceContract' { $object = 'CONTRACT::[{0}]' -f $objectPermission.ObjectName } 'ServiceRoute' { $object = 'ROUTE::[{0}]' -f $objectPermission.ObjectName } 'SqlAssembly' { $object = 'ASSEMBLY::[{0}]' -f $objectPermission.ObjectName } 'SymmetricKey' { $object = 'SYMMETRIC KEY::[{0}]' -f $objectPermission.ObjectName } 'User' { $object = 'USER::[{0}]' -f $objectPermission.ObjectName } 'UserDefinedType' { $object = 'TYPE::[{0}].[{1}]' -f $objectPermission.ObjectSchema, $objectPermission.ObjectName } 'XmlNamespace' { $object = 'XML SCHEMA COLLECTION::[{0}]' -f $objectPermission.ObjectName } } if ($objectPermission.PermissionState -eq "GrantWithGrant") { $withGrant = " WITH GRANT OPTION" $grantObjectPermission = 'GRANT' } else { $withGrant = " " $grantObjectPermission = $objectPermission.PermissionState.ToString().ToUpper() } $outsql += "$grantObjectPermission $($objectPermission.PermissionType) ON $object TO [$($objectPermission.Grantee)]$withGrant AS [$($objectPermission.Grantor)];" } } catch { Stop-Function -Message "This user may be using functionality from $($versionName[$db.CompatibilityLevel.ToString()]) that does not exist on the destination version ($versionNameDesc)." -Continue -InnerErrorRecord $_ -Target $db } if (@($perms.Count) -gt 0) { if ($ExcludeGoBatchSeparator) { $sql = "$useDatabase $outsql" } else { if ($useDatabase) { $sql = "$useDatabase`r`nGO`r`n" + ($outsql -join "`r`nGO`r`n") } else { $sql = $outsql -join "`r`nGO`r`n" } #add the final GO $sql += "`r`nGO" } } if (-not $Passthru) { # If generate a file per user, clean the collection to populate with next one if ($GenerateFilePerUser) { if (-not [string]::IsNullOrEmpty($sql)) { $sql | Out-File -Encoding UTF8 -FilePath $FilePath -Append:$Append -NoClobber:$NoClobber Get-ChildItem -Path $FilePath } } else { $sql | Out-File -Encoding UTF8 -FilePath $FilePath -Append:$Append -NoClobber:$NoClobber } # Clear variables for next user $outsql = @() $sql = "" } else { $sql } } } # Just a single file, output path once here if (-Not $GenerateFilePerUser) { Get-ChildItem -Path $FilePath } } } |