summaryrefslogtreecommitdiffstats
path: root/ansible_collections/lowlydba/sqlserver/plugins/modules/user.ps1
blob: 4137559e7336b68dd619455309d510407c4311a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
#!powershell
# -*- coding: utf-8 -*-

# (c) 2022, John McCall (@lowlydba)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

#AnsibleRequires -CSharpUtil Ansible.Basic
#AnsibleRequires -PowerShell ansible_collections.lowlydba.sqlserver.plugins.module_utils._SqlServerUtils
#Requires -Modules @{ ModuleName="dbatools"; ModuleVersion="2.0.0" }

$ErrorActionPreference = "Stop"

$spec = @{
    supports_check_mode = $true
    options = @{
        login = @{type = 'str'; required = $true }
        database = @{type = 'str'; required = $true }
        username = @{type = 'str'; required = $true }
        default_schema = @{type = 'str'; required = $false ; default = 'dbo' }
        external_provider = @{type = 'bool'; required = $false }
        state = @{type = 'str'; required = $false; default = 'present'; choices = @('present', 'absent') }
    }
}

$module = [Ansible.Basic.AnsibleModule]::Create($args, $spec, @(Get-LowlyDbaSqlServerAuthSpec))
$sqlInstance, $sqlCredential = Get-SqlCredential -Module $module
$login = $module.Params.login
$username = $module.Params.username
$database = $module.Params.database
$defaultSchema = $module.Params.default_schema
[nullable[bool]]$externalProvider = $module.Params.external_provider
$state = $module.Params.state
$checkMode = $module.CheckMode

$module.Result.changed = $false

$getUserSplat = @{
    SqlInstance = $sqlInstance
    SqlCredential = $sqlCredential
    User = $username
    Login = $login
    Database = $database
    EnableException = $true
}
$existingUser = Get-DbaDbUser @getUserSplat

if ($state -eq "absent") {
    if ($null -ne $existingUser) {
        try {
            $removeUserSplat = @{
                SqlInstance = $sqlInstance
                SqlCredential = $sqlCredential
                User = $username
                Database = $database
                EnableException = $true
                WhatIf = $checkMode
                Force = $true
                Confirm = $false
            }
            $output = Remove-DbaDbUser @removeUserSplat
            $module.Result.changed = $true
        }
        catch {
            $module.FailJson("Removing user failed: $($_.Exception.Message)", $_)
        }
    }
}
elseif ($state -eq "present") {
    # User exists
    if ($null -ne $existingUser) {
        if ($defaultSchema -ne $existingUser.DefaultSchema) {
            try {
                # No Set-DbaDbUser command exists, use SMO
                $getSchemaSplat = @{
                    SqlInstance = $sqlInstance
                    SqlCredential = $sqlCredential
                    Database = $database
                    Schema = $defaultSchema
                    IncludeSystemDatabases = $true
                    IncludeSystemSchemas = $true
                    EnableException = $true
                }
                $existingSchema = Get-DbaDbSchema @getSchemaSplat

                if ($null -ne $existingSchema) {
                    # do schema change
                    if (-not($checkMode)) {
                        $existingUser.DefaultSchema = $defaultSchema
                        $existingUser.Alter()
                        $output = $existingUser
                    }
                    $module.result.changed = $true
                }
                else {
                    $module.FailJson("Schema '$defaultSchema' not found in [$database].")
                }
            }
            catch {
                $module.FailJson("Configuring user failed: $($_.Exception.Message)", $_)
            }
        }
    }
    # New User
    else {
        try {
            $newUserSplat = @{
                SqlInstance = $sqlInstance
                SqlCredential = $sqlCredential
                Username = $username
                Login = $login
                Database = $database
                DefaultSchema = $defaultSchema
                IncludeSystem = $true
                EnableException = $true
                WhatIf = $checkMode
                Force = $true
                Confirm = $false
            }
            if ($externalProvider -eq $true) {
                $newUserSplat.add("ExternalProvider", $true)
            }
            $output = New-DbaDbUser @newUserSplat
            $module.result.changed = $true
        }
        catch {
            $module.FailJson("Creating user failed: $($_.Exception.Message)", $_)
        }
    }
    # If not in check mode, add extra fields we can change to default display set
    if ($null -ne $output) {
        $output.PSStandardMembers.DefaultDisplayPropertySet.ReferencedPropertyNames.Add("DefaultSchema")
    }
}
try {
    if ($null -ne $output) {
        $resultData = ConvertTo-SerializableObject -InputObject $output
        $module.Result.data = $resultData
    }
    $module.ExitJson()
}
catch {
    $module.FailJson("Failure: $($_.Exception.Message)", $_)
}