BitTitan.Runbooks.PartnerCenter.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
<#
.SYNOPSIS
    Powershell module for common Partner Center functions and resources used in BitTitan Runbooks
.NOTES
    Version: 0.1.1
    Last updated: 1 October 2018
 
    Copyright (c) BitTitan, Inc. All rights reserved.
    Licensed under the MIT License.
#>


<#
.SYNOPSIS
    This function connects to Partner Center using admin account credentials or a MSPComplete Endpoint.
.DESCRIPTION
    This function connects to Partner Center using admin account credentials or a MSPComplete Endpoint.
    It returns whether the connection and logon was successful.
.PARAMETER username
    The username of the Partner Center admin account.
.PARAMETER password
    The password of the Partner Center admin account.
.PARAMETER applicationId
    The Partner Center Native App Application Id.
.PARAMETER endpoint
    The MSPComplete Endpoint for the Partner Center admin credentials.
.EXAMPLE
    Connect-PartnerCenterAdminAccount -Endpoint $Endpoint
.EXAMPLE
    $Endpoint | Connect-PartnerCenterAdminAccount
.EXAMPLE
    Connect-PartnerCenterAdminAccount -Username $username -Password $password -ApplicationId $applicationId
#>

function Connect-PartnerCenterAdminAccount {
    param (
        # The username of the Partner Center admin account.
        [Parameter(Mandatory=$true, ParameterSetName="credential")]
        [String]$username,

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

        # The Partner Center Native App Application Id
        [Parameter(Mandatory=$true, ParameterSetName="credential")]
        [GUID]$applicationId,

        # The MSPComplete Endpoint for the Partner Center admin credentials.
        [Parameter(Mandatory=$true, ParameterSetName="endpoint", ValueFromPipeline=$true)]
        $endpoint
    )

    # If given endpoint, retrieve credential directly
    if ($PSCmdlet.ParameterSetName -eq "endpoint") {
        $partnerCenterCredential = $endpoint | Get-CredentialFromMSPCompleteEndpoint
        $username = $partnerCenterCredential.Username

        # Check if endpoint has application ID extended property
        if ($null -eq $endpoint.ExtendedProperties -or $null -eq $endpoint.ExtendedProperties.ApplicationId) {
            Write-Error "Endpoint provided does not have an 'ApplicationId' extended property."
            return $false
        }
        $applicationId = $endpoint.ExtendedProperties.ApplicationId
    }

    # Create the Partner Center credential from the given username and password
    else {
        $partnerCenterCredential = New-Object System.Management.Automation.PSCredential($username, $password)
    }

    # Logon to Partner Center
    try {
        Connect-PartnerCenter -ApplicationId $applicationId -Credential $partnerCenterCredential -ErrorAction Stop

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

    # Error while attempting to logon
    catch {
        Write-Error "Error while attempting to logon to Partner Center account with username '$($username)'. `r`n$($_.Exception.Message)"
        return $false
    }
}