Functions/Connect-MicrosoftOnline.ps1
|
<#
.SYNOPSIS Connect the PowerShell modules to the specified tenant. .DESCRIPTION This command uses the registered Microsoft Online tenant with it's connection details to connect to all services and their moduels specified in the scope. .INPUTS None. .OUTPUTS MicrosoftOnlineFever.Connection. The opened connections. .EXAMPLE PS C:\> Connect-MicrosoftOnline -Name 'Contoso' Connect to all supported scopes on the specified tenant. .EXAMPLE PS C:\> Connect-MicrosoftOnline -Name 'Contoso' -Scope 'Exchange', 'SharePoint' Connect to Exchange Online and SharePoint Online on the specified tenant. .EXAMPLE PS C:\> m365 'Contoso' Use one of the aliases to connect to the tenant. .LINK https://github.com/claudiospizzi/MicrosoftOnlineFever #> function Connect-MicrosoftOnline { [CmdletBinding()] [Alias('aad', 'o365', 'm365')] param ( # The tenant name. [Parameter(Mandatory = $true, Position = 0)] [System.String] $Name, [Parameter(Mandatory = $false)] [ValidateSet('AzureAD', 'MSOL', 'Graph', 'Azure', 'Exchange', 'SecurityCompliance', 'SharePoint', 'Teams')] [System.String[]] $Scope, # Use the preview modules if available. [Parameter(Mandatory = $false)] [Alias('Preview')] [Switch] $UsePreviewModule ) # Define the default scopes, if non was specified. if (-not $PSBoundParameters.ContainsKey('Scope')) { $Scope = 'AzureAD', 'Graph', 'Azure', 'Exchange', 'SharePoint', 'Teams' } Test-MicrosoftOnlineModuleDependency -Scope $Scope -UsePreviewModule:$UsePreviewModule # Ensure that the Exchange scope is used if the SecurityCompliance is # requested. This depends on the Exchange scope. if ($Scope -contains 'SecurityCompliance' -and $Scope -notcontains 'Exchange') { $Scope += 'Exchange' } $tenant = Get-MicrosoftOnlineTenant -Name $Name if ($null -eq $tenant) { throw "Tenant named $Name not found." } if (@($tenant).Count -gt 1) { throw "Multiple tenants named $Name found." } $orderedScopes = 'AzureAD', 'MSOL', 'Graph', 'Azure', 'Exchange', 'SecurityCompliance', 'SharePoint', 'Teams' foreach ($currentScope in $orderedScopes) { if ($currentScope -in $Scope) { try { $connection = [PSCustomObject] @{ PSTypeName = 'MicrosoftOnlineFever.Connection' Scope = $currentScope Module = '' Tenant = '' Domain = '' } # Microsoft Azure Active Directory PowerShell for Graph (*-AzureAD*) if ($currentScope -eq 'AzureAD') { $contextAzureAD = Connect-AzureAD -TenantId $tenant.TenantId -ApplicationId $tenant.ApplicationId -CertificateThumbprint $tenant.CertificateThumbprint $contextAzureAD | ForEach-Object { $connection.Module = $(if ($UsePreviewModule.IsPresent) { 'AzureADPreview' } else { 'AzureAD' }) $connection.Tenant = $_.TenantId $connection.Domain = $_.TenantDomain } } # Microsoft Azure Active Directory Module for Windows PowerShell (*-Msol*) if ($currentScope -eq 'MSOL') { # Connect-MsolService throw 'The MSOL module is currently not supported. Use this command to connect: Connect-MsolService' } # Microsoft Graph (*-Mg*) if ($currentScope -eq 'Graph') { Connect-MgGraph -TenantId $tenant.TenantId -ClientID $tenant.ApplicationId -CertificateThumbprint $tenant.CertificateThumbprint | Out-Null Get-MgContext | ForEach-Object { $connection.Module = 'Microsoft.Graph' $connection.Tenant = $_.TenantId $connection.Domain = 'n/a' } } # Azure PowerShell (*-Az*) if ($currentScope -eq 'Azure') { $contextAzure = Connect-AzAccount -Tenant $tenant.TenantId -ApplicationId $tenant.ApplicationId -CertificateThumbprint $tenant.CertificateThumbprint $contextAzure | ForEach-Object { $connection.Module = 'Az' $connection.Tenant = $_.Context.Tenant.Id $connection.Domain = 'n/a' } } # Exchange Online PowerShell V2 (*-EXO* / Classical Exchange Cmdlets) if ($currentScope -eq 'Exchange') { Connect-ExchangeOnline -Organization $tenant.TenantDomain -AppId $tenant.ApplicationId -CertificateThumbprint $tenant.CertificateThumbprint -ShowBanner:$false | Out-Null Get-OrganizationConfig | ForEach-Object { $connection.Module = 'ExchangeOnlineManagement' $connection.Tenant = 'n/a' $connection.Domain = $_.Name } } # Security & Compliance (based on Exchange Online PowerShell V2) if ($currentScope -eq 'SecurityCompliance') { # Connect-IPPSSession throw 'The SecurityCompliance module is currently not supported. Use this command to connect: Connect-IPPSSession' } # Microsoft 365 Patterns and Practices PowerShell Cmdlets (*-PnP*) if ($currentScope -eq 'SharePoint') { # Disable update change and telemetry $Env:PNPPOWERSHELL_UPDATECHECK = $false $Env:PNPPOWERSHELL_DISABLETELEMETRY = $true $tenantSharePointUrl = 'https://{0}.sharepoint.com' -f $tenant.TenantDomain.Split('.')[0] Connect-PnPOnline -ClientId $tenant.ApplicationId -CertificateBase64Encoded $tenant.CertificatePfx -CertificatePassword $tenant.CertificateSecret -Url $tenantSharePointUrl -Tenant $tenant.TenantDomain -Verbose:$false | Out-Null Get-PnPConnection| ForEach-Object { $connection.Module = 'PnP.PowerShell' $connection.Tenant = 'n/a' $connection.Domain = $_.Tenant } } # Microsoft Teams PowerShell if ($currentScope -eq 'Teams') { $contextTeams = Connect-MicrosoftTeams -TenantId $tenant.TenantId -ApplicationId $tenant.ApplicationId -CertificateThumbprint $tenant.CertificateThumbprint $contextTeams | ForEach-Object { $connection.Module = 'MicrosoftTeams' $connection.Tenant = $_.TenantId.Guid $connection.Domain = $_.TenantDomain } } Write-Output $connection } catch { Write-Warning "Failed to connect to $currentScope with: $_" } } } } # Register the argument completer for the Name parameter Register-ArgumentCompleter -CommandName 'Connect-MicrosoftOnline' -ParameterName 'Name' -ScriptBlock { param ($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters) Import-MicrosoftOnlineTenant -Path $Script:MicrosoftOnlineFeverTenantPath | ForEach-Object { [System.Management.Automation.CompletionResult]::new($_.Name, $_.Name, 'ParameterValue', $_.Name) } } |