Functions/Connect-MSOnlineAdminAccount.ps1

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
<#
.SYNOPSIS
    This function connects to MSOnline using admin account credentials or a MSPComplete Endpoint.
.DESCRIPTION
    This function connects to MSOnline using admin account credentials or a MSPComplete Endpoint.
    It returns whether the connection and logon was successful.
.EXAMPLE
    Connect-MSOnlineAdminAccount -Endpoint $Endpoint
.EXAMPLE
    $Endpoint | Connect-MSOnlineAdminAccount
.EXAMPLE
    Connect-MSOnlineAdminAccount -Username $username -Password $password
#>

function Connect-MSOnlineAdminAccount {
    [CmdletBinding(PositionalBinding=$false)]
    [OutputType([Bool])]
    param (
        # The username of the MSOnline account.
        [Parameter(Mandatory=$true, ParameterSetName="credential")]
        [String]$username,

        # The password of the MSOnline account.
        [Parameter(Mandatory=$true, ParameterSetName="credential")]
        [SecureString]$password,

        # The MSPComplete Endpoint.
        [Parameter(Mandatory=$true, ParameterSetName="endpoint", ValueFromPipeline=$true)]
        $endpoint
    )

    # If given endpoint, retrieve credential directly
    if ($PSCmdlet.ParameterSetName -eq "endpoint") {
        $msolCredential = $endpoint.Credential
        $username = $msolCredential.Username
    }

    # Create the MSOnline credential from the given username and password
    else {
        $msolCredential = [PSCredential]::new($username, $password)
    }

    # Logon to MSOnline
    try {
        Connect-MsolService -Credential $msolCredential -ErrorAction Stop

        # Logon was successful
        Write-Information "Connection and logon to MSOnline successful with username '$($username)'."
        return $true
    }

    # Logon was unsuccessful
    catch {
        Write-Error "Failed MSOnline account login with username '$($username)'.`r`n$($_.Exception.Message)"
        return $false
    }
}