11 Test Connection.ps1

param (
    [Parameter()]
    [string[]]$EnvironmentName,

    [Parameter()]
    [switch]$DoNotDisconnect,

    [Parameter()]
    [string]$SetupApplicationName = 'M365DscSetupApplication'
)

$requiredModulesPath = (Resolve-Path -Path $PSScriptRoot\..\output\RequiredModules).Path
if ($env:PSModulePath -notlike "*$requiredModulesPath*")
{
    $env:PSModulePath = $env:PSModulePath + ";$requiredModulesPath"
}

Import-Module -Name $PSScriptRoot\AzHelpers.psm1 -Force
$datum = New-DatumStructure -DefinitionFile $PSScriptRoot\..\source\Datum.yml
$environments = $datum.Global.Azure.Environments.Keys

if ($EnvironmentName)
{
    Write-Host "Filtering environments to: $($EnvironmentName -join ', ')" -ForegroundColor Magenta
    $environments = $environments | Where-Object { $EnvironmentName -contains $_ }
}
Write-Host "Setting up environments: $($environments -join ', ')" -ForegroundColor Magenta

foreach ($envName in $environments)
{
    $environment = $datum.Global.Azure.Environments."$envName"
    $setupIdentity = $environment.Identities | Where-Object Name -EQ $SetupApplicationName
    Write-Host "Testing connection to environment '$envName'" -ForegroundColor Magenta

    if (-not $setupIdentity.ApplicationId)
    {
        Write-Error "The setup identity '$SetupApplicationName' for environment '$envName' is not defined. Please run the '10 Setup App Registrations.ps1' script first." -ErrorAction Stop
    }

    $param = @{
        TenantId               = $environment.AzTenantId
        TenantName             = $environment.AzTenantName
        SubscriptionId         = $environment.AzSubscriptionId
        ServicePrincipalId     = $setupIdentity.ApplicationId
    }
    if ($setupIdentity.ApplicationSecret)
    {
        $param.ServicePrincipalSecret = $setupIdentity.ApplicationSecret | ConvertTo-SecureString -AsPlainText -Force
    }
    else
    {
        $param.CertificateThumbprint = $setupIdentity.CertificateThumbprint
    }

    Connect-M365Dsc @param -ErrorAction Stop

    Test-M365DscConnection -TenantId $environment.AzTenantId -SubscriptionId $environment.AzSubscriptionId -ErrorAction Stop | Out-Null

    if (-not $DoNotDisconnect)
    {
        Disconnect-M365Dsc
    }
}

Write-Host 'Connection test completed' -ForegroundColor Green