Connect-MS365.psm1

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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
#.ExternalHelp Connect-MS365-help.xml
<#
.SYNOPSIS
Connects to a given online service of Microsoft.
 
.DESCRIPTION
Connects to a given online service of Microsoft.
One or multiple service names can be chosen. Supports connection handling for
- Microsoft Online (MSOL)
- Exchange Online (EOL)
- Teams
 
.PARAMETER Service
Specifies the service to connect to. May be a list of multiple services to use.
 
.PARAMETER MFA
Toggles MFA usage. Not requesting PSCredential object.
 
.INPUTS
None. You cannot pipe objects to Add-Extension.
 
.OUTPUTS
// <OBJECTTYPE>. TBD.
 
.EXAMPLE
Connect-MS365 -Service MSOL
 
.EXAMPLE
Connect-MS365 -Service MSOL -MFA
 
.EXAMPLE
Connect-MS365 -Service MSOL,EOL -MFA
 
.LINK
https://github.com/blindzero/Connect-MS365
 
#>

function Connect-MS365 {

    [OutputType()]
    [CmdletBinding(DefaultParameterSetName)]
    param (
        #service parameter to define to which services to connect to
        #are validated against available / implemented services
        [Parameter(Mandatory=$True, Position = 1)]
        [ValidateSet('MSOL','EOL','Teams')]
        [string[]]
        $Service,
        #mfa parameter if mfa authentication is necessary
        #used later to determine different connection commands and is not using PScredential object
        [Parameter(Mandatory=$False, Position = 2, ParameterSetName = 'MFA')]
        [Switch]
        $MFA,
        #Credential parameter to receive previously created PSCredential object.
        #Primarily needed for testing calls
        [Parameter(Mandatory = $False, Position = 3, ParameterSetName = 'Credential')]
        [PSCredential]
        $Credential
    )

    # dont gather PSCredential object if MFA is set
    If (($MFA -ne $True) -and (!($Credential))) {
        Write-Verbose "Gathering PSCredentials object for non MFA sign on"
        $Credential = Get-Credential -Message "Please enter your Office 365 credentials"
    }
    
    # iterating through each service listed in service parameter
    # each service is passing PSCredential object if MFA not set or leaves it out if set
    ForEach ($ServiceItem in $Service) {
        Write-Verbose "Create session to Service $ServiceItem"
        Switch($ServiceItem) {
            # Microsoft Online service
            MSOL {
                if ($MFA) {
                    Connect-MSOL
                }
                else {
                    Connect-MSOL -Credential $Credential
                }
                continue
            }
            # Exchange Online service
            EOL {
                if ($MFA) {
                    Connect-EOL
                }
                else {
                    Connect-EOL -Credential $Credential
                }
                continue
            }
            # Exchange Online service
            Teams {
                if ($MFA) {
                    Connect-Teams
                }
                else {
                    Connect-Teams -Credential $Credential
                }
                continue
            }
        }
        Write-Verbose "Create session to Service $ServiceItem done."
    }

    Write-Verbose "Connect-MS365 terminated."
}

# Export only the functions using PowerShell standard verb-noun naming.
# Be sure to list each exported functions in the FunctionsToExport field of the module manifest file.
# This improves performance of command discovery in PowerShell.
Export-ModuleMember -Function Connect-MS365
function Install-MS365Module {
    [CmdletBinding()]
    param (
        # service module to be installed, must be known service
        [Parameter(Mandatory=$True,Position=1)]
        [ValidateSet('MSOL','EOL','Teams')]
        [String]
        $Service
    )

    <#
    .SYNOPSIS
 
    Installs modules to connect for a given service.
 
    .DESCRIPTION
 
    Installs modules to connect for a given service.
    Service name needs to be passed.
 
    .PARAMETER Service
    Name of service to check installed modules for.
 
    .INPUTS
 
    None. You cannot pipe objects to Add-Extension.
 
    .OUTPUTS
 
    // <OBJECTTYPE>. TBD.
 
    .EXAMPLE
 
    Install-MS365Module -Service MSOL
 
    .LINK
 
    http://github.com/blindzero/Connect-MS365
 
    #>


    switch($Service) {
        MSOL {
            $ModuleName = "MSOnline"
        }
        EOL {
            $ModuleName = "ExchangeOnlineManagement"
        }
        Teams {
            $ModuleName = "MicrosoftTeams"
        }
    }

    $InstallCommand = "-Command &{ Install-Module -Name $ModuleName -Scope AllUsers }"
    $InstallChoice = Read-Host -Prompt "$ModuleName Module is not present! Install it (Y/n)"
    If (($InstallChoice -eq "") -or ($InstallChoice -eq "y") -or ($InstallChoice -eq "Y")) {
        try {
            Start-Process -Filepath powershell -ArgumentList $InstallCommand -Verb RunAs -Wait
        }
        catch {
            $ErrorMessage = $_.Exception.Message
            Write-Error -Message "Could not install Module $ModuleName.`n$ErrorMessage" -Category ConnectionError
            Break
        }
        continue
    }
}

function Set-WindowTitle {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$True,Position=1)]
        [String]
        $Service
    )

    <#
    .SYNOPSIS
 
    Sets Window Title if connection was successful.
 
    .DESCRIPTION
 
    Sets Window Title if connection was successful.
    Adds prefix if not already set.
 
    .PARAMETER Service
    Name of service to put in Window title.
 
    .INPUTS
 
    None. You cannot pipe objects to Add-Extension.
 
    .OUTPUTS
 
    // <OBJECTTYPE>. TBD.
 
    .EXAMPLE
 
    Set-WindowTitle -Service MSOL
 
    .LINK
 
    http://github.com/blindzero/Connect-MS365
 
    #>

    If (($host.ui.RawUI.WindowTitle) -notlike "*$ServiceItem*" ) {
        If (($host.ui.RawUI.WindowTitle) -notlike "*Connected To:*") {
                $host.ui.RawUI.WindowTitle += " -- Connected To: $ServiceItem"
        }
        Else {
            $host.ui.RawUI.WindowTitle += " || $ServiceItem"
        }
    }
}
function Test-MS365Module {
    [CmdletBinding()]
    param (
        # service module to be tested, must be known service
        [Parameter(Mandatory=$True,Position=1)]
        [ValidateSet('MSOL','EOL','Teams')]
        [String]
        $Service
    )

    <#
    .SYNOPSIS
 
    Checks if a module of a given service to connect is installed.
 
    .DESCRIPTION
 
    Checks if a module of a given service to connect is installed.
    Service name needs to be passed.
 
    .PARAMETER Service
    Name of service to check installed modules for.
 
    .INPUTS
 
    None. You cannot pipe objects to Add-Extension.
 
    .OUTPUTS
 
    // <OBJECTTYPE>. TBD.
 
    .EXAMPLE
 
    Test-MS365Module -Service MSOL
 
    .LINK
 
    http://github.com/blindzero/Connect-MS365
 
    #>


    # Set Splatting argument list for Get-Module used to determine if module is existing
    $GetModulesSplat = @{
        ListAvailable = $True
        Verbose          = $False
    }

    # TODO #10: changing to settings array containing module names making switch unnecessary

    Switch($Service) {
        # Microsoft Online Service
        MSOL {
            If ($null -eq (Get-Module @GetModulesSplat -Name "MSOnline")) {
                $False
            }
            Else {
                $True
            }
        }
        # Exchange Online Service
        EOL {
            If ($null -eq (Get-Module @GetModulesSplat -Name "ExchangeOnlineManagement")) {
                $False
            }
            Else {
                $True
            }
        }
        # Teams
        Teams {
            If ($null -eq (Get-Module @GetModulesSplat -Name "MicrosoftTeams")) {
                $False
            }
            Else {
                $True
            }
        }
    }
}

function Connect-EOL {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$False,Position=1)]
        [PSCredential]
        $Credential
    )

    <#
    .SYNOPSIS
 
    Connects to Microsoft Exchange Online service.
 
    .DESCRIPTION
 
    Connects to Microsoft Exchange Online service.
 
    .PARAMETER Credential
 
    PSCredential object containing user credentials.
 
    .INPUTS
 
    None. You cannot pipe objects to Add-Extension.
 
    .OUTPUTS
 
    // <OBJECTTYPE>. TBD.
 
    .EXAMPLE
 
    PS> Connect-EOL -Credential $Credential
 
    .LINK
 
    http://github.com/blindzero/Connect-MS365
 
    #>


    # testing if module is available
    while (!(Test-MS365Module -Service $ServiceItem)) {
        # and install if not available
        Install-MS365Module -Service $ServiceItem
    }
    try {
        # if MFA is set connect without PScredential object as modern authentication will be used
        if ($MFA) {
            Connect-ExchangeOnline -ShowProgress $true
        }
        # or pass PSCredential object it will asked if not created earlier
        else {
            Connect-ExchangeOnline -Credential $Credential -ShowProgress $true
        }
    }
    catch {
        $ErrorMessage = $_.Exception.Message
        Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError
        Break
    }
    # set service name into window title if successfully connected
    Set-WindowTitle -Service $ServiceItem
}
function Connect-MSOL {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$False,Position=1)]
        [PSCredential]
        $Credential
    )

    <#
    .SYNOPSIS
 
    Connects to Microsoft Online service.
 
    .DESCRIPTION
 
    Connects to Microsoft Online service.
 
    .PARAMETER Credential
 
    PSCredential object containing user credentials.
 
    .INPUTS
 
    None. You cannot pipe objects to Add-Extension.
 
    .OUTPUTS
 
    // <OBJECTTYPE>. TBD.
 
    .EXAMPLE
 
    PS> Connect-MSOL -Credential $Credential
 
    .LINK
 
    http://github.com/blindzero/Connect-MS365
 
    #>


    # testing if module is available
    while (!(Test-MS365Module -Service $ServiceItem)) {
        # and install if not available
        Install-MS365Module -Service $ServiceItem
    }
    try {
        # if MFA is set connect without PScredential object as modern authentication will be used
        if ($MFA) {
            Connect-MsolService -ErrorAction Stop
        }
        # or pass PSCredential object it will asked if not created earlier
        else {
            Connect-MsolService -Credential $Credential -ErrorAction Stop
        }
    }
    catch {
        $ErrorMessage = $_.Exception.Message
        Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError
        Break
    }
    # set service name into window title if successfully connected
    Set-WindowTitle -Service $ServiceItem
}
function Connect-Teams {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory=$False,Position=1)]
        [PSCredential]
        $Credential
    )

    <#
    .SYNOPSIS
 
    Connects to Microsoft Teams service.
 
    .DESCRIPTION
 
    Connects to Microsoft Teams service.
 
    .PARAMETER Credential
 
    PSCredential object containing user credentials.
 
    .INPUTS
 
    None. You cannot pipe objects to Add-Extension.
 
    .OUTPUTS
 
    // <OBJECTTYPE>. TBD.
 
    .EXAMPLE
 
    PS> Connect-Teams -Credential $Credential
 
    .LINK
 
    http://github.com/blindzero/Connect-MS365
 
    #>


    # testing if module is available
    while (!(Test-MS365Module -Service $ServiceItem)) {
        # and install if not available
        Install-MS365Module -Service $ServiceItem
    }
    try {
        # if MFA is set connect without PScredential object as modern authentication will be used
        if ($MFA) {
            Connect-MicrosoftTeams -ErrorAction Stop | Out-Null
        }
        # or pass PSCredential object it will asked if not created earlier
        else {
            Connect-MicrosoftTeams -Credential $Credential -ErrorAction Stop | Out-Null
        }
    }
    catch {
        $ErrorMessage = $_.Exception.Message
        Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError
        Break
    }
    # set service name into window title if successfully connected
    Set-WindowTitle -Service $ServiceItem
}