TeamsFunctions

22.10

Public/Support/Session/Get-CurrentConnectionInfo.ps1

# Module: TeamsFunctions
# Function: Session
# Author: David Eberhardt
# Updated: 01-OCT-2020
# Status: Live




function Get-CurrentConnectionInfo {
  <#
  .SYNOPSIS
    Queries AzureAd, MicrosoftTeams and ExchangeOnline for currently established Sessions
  .DESCRIPTION
    Returns an object displaying all currently connected PowerShell Sessions and basic output about the Tenant.
  .EXAMPLE
    Get-CurrentConnectionInfo
 
    Will Test current connection to AzureAd, MicrosoftTeams and ExchangeOnline and displays simple output object.
  .INPUTS
    None
  .OUTPUTS
    System.Object
  .NOTES
    Information about a Service is only displayed if an active connection can be found
  .COMPONENT
    TeamsSession
  .FUNCTIONALITY
    Queries Information about existing Sessions to AzureAd and MicrosoftTeams
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Get-CurrentConnectionInfo.md
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_TeamsSession.md
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/
  #>

  [CmdletBinding()]
  [Alias('cur')]
  [OutputType([Boolean])]
  param() #param

  begin {
    Show-FunctionStatus -Level Live
    $Stack = Get-PSCallStack
    $Called = ($stack.length -ge 3)
  } #begin

  process {

    # Creating main Object
    $SessionInfo = [PSCustomObject][ordered]@{
      PSTypeName                = 'PowerShell.TeamsFunctsions.Session.ConnectionInfo'
      Account                   = ''
      Tenant                    = ''
      TenantDomain              = ''
      TenantId                  = ''
      ConnectedTo               = [System.Collections.Generic.List[object]]@()
      AzureEnvironment          = ''
      TeamsUpgradeEffectiveMode = ''
    }
    #AzureAd SessionInfo
    $ConnectedToAD = Test-AzureADConnection
    if ( $ConnectedToAD ) {
      $SessionInfo.ConnectedTo += 'AzureAd'
      $AzureAdFeedback = Get-AzureADCurrentSessionInfo
      $SessionInfo.Account = $AzureAdFeedback.Account.Id
      $SessionInfo.Tenant = "$($AzureAdFeedback.Account.Id.split('@')[1])"
      $SessionInfo.TenantDomain = $AzureAdFeedback.TenantDomain
      $SessionInfo.TenantId = $AzureAdFeedback.TenantId
      $SessionInfo.AzureEnvironment = $AzureAdFeedback.Environment
    }

    #MicrosoftTeams SessionInfo
    $ConnectedToTeams = Test-MicrosoftTeamsConnection
    if ( $ConnectedToTeams ) {
      try {
        #This will also initialise (or reconnect) the SkypeOnline part of MicrosoftTeams and test Admin roles
        $CsTenant = Get-CsTenant -WarningAction SilentlyContinue -ErrorAction Stop
      }
      catch {
        Write-Warning -Message 'Connection to MicrosoftTeams established, but Command not successful. Please validate your Admin Roles and reconnect: https://aka.ms/myroles'
        if (-not $called) {
          Write-Error -Message "$($_.Exception.Message)"
        }
        Write-Verbose -Message 'The TeamsUpgradeEffectiveMode is not shown as it cannot be queried from the Tenant'
      }
      $SessionInfo.ConnectedTo += 'MicrosoftTeams'
      if ($CsTenant.DisplayName) {
        $SessionInfo.Tenant = $($CsTenant.DisplayName)
      }
      $SessionInfo.TeamsUpgradeEffectiveMode = $CsTenant.TeamsUpgradeEffectiveMode
    }

    #Exchange SessionInfo
    if ( Test-ExchangeOnlineConnection ) {
      $SessionInfo.ConnectedTo += 'ExchangeOnline'
      #What to add?
      if ($PSBoundParameters.ContainsKey('Debug') -or $DebugPreference -eq 'Continue') {
        " Function: $($MyInvocation.MyCommand.Name) - ExchangeOnlineFeedback:", ($ExchangeOnlineFeedback | Format-Table -AutoSize | Out-String).Trim() | Write-Debug
      }
    }

    #Output
    Write-Output $SessionInfo
  } #process

  end {

  } #end

} #Get-CurrentConnectionInfo