Public/Teams/Get-TeamsTenant.ps1
|
# Module: TeamsFunctions # Function: Lookup # Author: David Eberhardt # Updated: 11-NOV-2020 # Status: Live function Get-TeamsTenant { <# .SYNOPSIS Lists basic Tenant information .DESCRIPTION To gain a quick overview, this wrapper for Get-CsTenant will display basic information .EXAMPLE Get-TeamsTenant Lists basic tenant information relevant for working on this Tenant .INPUTS None .OUTPUTS System.Object .NOTES None .COMPONENT SupportingFunction .FUNCTIONALITY Queries abbreviated information about the Teams Tenant .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Get-TeamsTenant.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_Supporting_Functions.md .LINK https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/ #> [CmdletBinding()] param ( ) begin { Show-FunctionStatus -Level Live Write-Verbose -Message "[BEGIN ] $($MyInvocation.MyCommand)" if ( $PSBoundParameters.ContainsKey('InformationAction')) { $InformationPreference = $PSCmdlet.SessionState.PSVariable.GetValue('InformationAction') } else { $InformationPreference = 'Continue' } # Asserting MicrosoftTeams Connection if ( -not (Assert-MicrosoftTeamsConnection) ) { break } # Querying Version Number for if ( -not $global:TeamsFunctionsMSTeamsModule) { $global:TeamsFunctionsMSTeamsModule = Get-Module MicrosoftTeams } # Format enumeration $FormatEnumerationLimit = -1 # Unlimited (for Domains) # preparing Output Field Separator $OFS = ', ' # do not remove - Automatic variable, used to separate elements! function Get-CsHostedMigrationURL { #Curtesy of Eric Marsi - https://www.ucit.blog/post/random-powershell-code-snippets-functions-library [CmdletBinding()] param( [Parameter(Mandatory)] [String]$Domain ) $HMSID = try { (((Invoke-WebRequest -Uri "https://webdir.online.lync.com/Autodiscover/AutodiscoverService.svc/root?originalDomain=$($Domain)").content -split 'webdir')[3] -split '.online')[0] } catch { Write-Error "Failed to get the Hosted Migration URL. The exception caught was $_" -ErrorAction Stop } $MigrationURL = 'https://admin' + "$($HMSID)" + '.online.lync.com/HostedMigration/hostedmigrationService.svc' return $MigrationURL } } #begin process { Write-Verbose -Message "[PROCESS] $($MyInvocation.MyCommand)" Write-Information 'INFO: This is abbreviated output of Get-CsTenant. For full information, please run Get-CsTenant' Write-Debug -Message 'Querying Tenant' $TenantObject = Get-CsTenant -WarningAction SilentlyContinue # This should trigger a reconnect as well. #Determining OverrideURL Write-Debug -Message 'Determining URLs' $TenantDomain = $(Get-AzureADCurrentSessionInfo).TenantDomain $OverrideURL = Get-CsHostedMigrationURL $TenantDomain # Adding OverrideURL $TenantObject | Add-Member -MemberType NoteProperty -Name TenantDomain -Value $TenantDomain -Force $TenantObject | Add-Member -MemberType NoteProperty -Name HostedMigrationOverrideURL -Value $OverrideURL -Force #Filtering Object if ( $TeamsFunctionsMSTeamsModule.Version -ge 3.0.0 ) { $Object = $TenantObject | Select-Object TenantId, DisplayName, CountryAbbreviation, PreferredLanguage, ProvisionedPlan, ` TeamsUpgradeEffectiveMode, TeamsUpgradeNotificationsEnabled, TeamsUpgradePolicyIsReadOnly, TeamsUpgradeOverridePolicy, ` DirSyncEnabled, WhenCreated, CompanyPartnership, HostedMigrationOverrideURL, TenantDomain, VerifiedDomains, SipDomain } elseif ( $TeamsFunctionsMSTeamsModule.Version -gt 2.3.1 ) { $Object = $TenantObject | Select-Object TenantId, DisplayName, CountryAbbreviation, PreferredLanguage, ` TeamsUpgradeEffectiveMode, TeamsUpgradeNotificationsEnabled, TeamsUpgradePolicyIsReadOnly, TeamsUpgradeOverridePolicy, ` DefaultDataLocation, DirSyncEnabled, WhenCreated, HostedMigrationOverrideURL, TenantDomain, Domains #Reworking Domains and filtering onmicrosoft.com domains. Adding Script Method for Domains $Domains = $TenantObject.Domains Write-Debug -Message 'Querying OnMSFT Domains' $ManagedOnMicrosoftDomains = $Domains | Where-Object Name -Match '.onmicrosoft.com' $Object | Add-Member -MemberType NoteProperty -Name ManagedOnMicrosoftDomains -Value $ManagedOnMicrosoftDomains.Name -Force Write-Debug -Message 'Querying Comms Domains' $ManagedCommunicationsDomains = $Domains | Where-Object Capability -Match 'OfficeCommunicationsOnline' $Object | Add-Member -MemberType NoteProperty -Name ManagedCommunicationsDomains -Value $ManagedCommunicationsDomains.Name -Force Write-Debug -Message 'Querying SIP Domains' $SipDomains = Get-CsOnlineSipDomain -WarningAction SilentlyContinue $Object | Add-Member -MemberType NoteProperty -Name ManagedSipDomains -Value $SipDomains.Name -Force } else { $Object = $TenantObject | Select-Object TenantId, DisplayName, CountryAbbreviation, PreferredLanguage, ` TeamsUpgradeEffectiveMode, TeamsUpgradeNotificationsEnabled, TeamsUpgradePolicyIsReadOnly, TeamsUpgradeOverridePolicy, ` ExperiencePolicy, DirSyncEnabled, LastSyncTimeStamp, IsValid, WhenCreated, WhenChanged, TenantPoolExtension, TenantDomain, HostedMigrationOverrideURL #Reworking Domains and filtering onmicrosoft.com domains. Adding Script Method for Domains $Domains = $TenantObject.Domains.Split(',') #| Select-Object -First 10 [psCustomObject]$DomainsOnMicrosoft = @() foreach ($D in $Domains) { if ($D.EndsWith('.onmicrosoft.com')) { $DomainsOnMicrosoft += "$D" } } $Object | Add-Member -MemberType NoteProperty -Name DomainsOnMicrosoft -Value $DomainsOnMicrosoft -Force $Object | Add-Member -MemberType NoteProperty -Name Domains -Value $Domains -Force $Object.Domains | Add-Member -MemberType ScriptMethod -Name ToString -Value { $this.Domains } -Force } return $Object } #process end { Write-Verbose -Message "[END ] $($MyInvocation.MyCommand)" } #end } #Get-TeamsTenant |