Connect-MS365.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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 |
#.ExternalHelp Connect-MS365-help.xml <# .SYNOPSIS Connects to a given online service of Microsoft. .DESCRIPTION Connects to a given online service of Microsoft. One or multiple service names can be chosen. Supports connection handling for - Microsoft Online (MSOL) - aka AzureAD v1 - Exchange Online (EOL) - Teams - SharePoint Online (SPO) - Security and Compliance Center (SCC) - Azure ActiveDirectory (AAD) v2 - Azure Platform (AZ) - Skype for Business Online service (S4B) .PARAMETER Service Specifies the service to connect to. May be a list of multiple services to use. .INPUTS None. You cannot pipe objects to Connect-MS365. .EXAMPLE Description: Connect to Microsoft Online Connect-MS365 -Service MSOL .EXAMPLE Description: Connect to Microsoft Online and Exchange Online Connect-MS365 -Service MSOL,EOL .EXAMPLE Description: Connect to SharePoint Online to connect to MyName-admin.sharepoint.com Connect-MS365 -Service SPO -SPOOrgName MyName .EXAMPLE Description: Connect to Security and Compliance Center Connect-MS365 -Service SCC .EXAMPLE Description: Connect to Azure ActiveDirectory Connect-MS365 -Service AAD .EXAMPLE Description: Connect to Microsoft Azure platform Connect-MS365 -Service AZ .EXAMPLE Description: Connect to Microsoft Skype for Business Online service Connect-MS365 -Service S4B .LINK https://github.com/blindzero/Connect-MS365 #> function Connect-MS365 { [OutputType()] [CmdletBinding(DefaultParameterSetName)] param ( #service parameter to define to which services to connect to #are validated against available / implemented services [Parameter(Mandatory=$True, Position = 1)] [ValidateSet('MSOL','EOL','Teams','SPO','SCC','AAD','AZ','S4B')] [string[]] $Service, #spoorg parameter for connection to SPO service #needed by connect cmdlet to assemble admin Url [Parameter(Mandatory=$False, Position = 2)] [string] [Alias('SPOOrg')] $SPOOrgName, #Credential parameter to receive previously created PSCredential object. #Primarily needed for testing calls [Parameter(Mandatory=$False, Position = 3, ParameterSetName = 'Credential')] [PSCredential] $Credential ) # TODO #10: changing to settings array containing module names making switch unnecessary # iterating through each service listed in service parameter ForEach ($ServiceItem in $Service) { Write-Verbose "Create session to Service $ServiceItem" Switch($ServiceItem) { # Microsoft Online service MSOL { $ServiceName = "Microsoft Online / AzureAD v1" $ModuleName = "MSOnline" $ModuleFindString = $ModuleName Connect-MSOL continue } # Exchange Online service EOL { $ServiceName = "Exchange Online" $ModuleName = "ExchangeOnlineManagement" $ModuleFindString = $ModuleName Connect-EOL continue } # Teams service Teams { $ServiceName = "Microsoft Teams" $ModuleName = "MicrosoftTeams" $ModuleFindString = $ModuleName Connect-Teams continue } # Security and Compliance Center SCC { $ServiceName = "Security & Compliance Center" $ModuleName = "ExchangeOnlineManagement" $ModuleFindString = $ModuleName Connect-SCC continue } # AzureAD AAD { $ServiceName = "AzureAD v2" $ModuleName = "AzureAD" $ModuleFindString = $ModuleName Connect-AAD continue } # Azure AZ { $ServiceName = "Azure" $ModuleName = "Az" $ModuleFindString = "Az.*" Connect-AZ continue } # SPO service SPO { $ServiceName = "SharePoint Online" $ModuleName = "Microsoft.Online.SharePoint.PowerShell" $ModuleFindString = $ModuleName If (!($SPOOrgName)) { Write-Error 'To connect to SharePoint Online you have to provide the -SPOOrgName parameter.' continue } Else { Write-Verbose "Assembling SPOOrgUrl from $SPOOrgName" $SPOOrgUrl = "https://$($SPOOrgName)-admin.sharepoint.com" Write-Verbose "Created $SPOOrgUrl" } Write-Verbose "Connecting to SharePoint Online at $SPOOrgUrl" Connect-SPO -SPOOrgUrl $SPOOrgUrl continue } # S4B Service S4B { $ServiceName = "Microsoft Skype4Business" $ModuleName = "SkypeOnlineConnector" $ModuleFindString = $ModuleName Connect-S4B continue } } Write-Verbose "Create session to Service $ServiceItem done." } Write-Verbose "Connect-MS365 done." } # Export only the functions using PowerShell standard verb-noun naming. # Be sure to list each exported functions in the FunctionsToExport field of the module manifest file. # This improves performance of command discovery in PowerShell. Export-ModuleMember -Function Connect-MS365 function Install-MS365Module { [CmdletBinding()] param ( # service module to be installed, must be known service [Parameter(Mandatory=$True,Position=1)] [String] $Module ) <# .SYNOPSIS Installs modules to connect for a given service. .DESCRIPTION Installs modules to connect for a given service. ModuleName name needs to be passed. .PARAMETER Module Name of powershell module to install. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE Install-MS365Module -Module MSOnline .LINK http://github.com/blindzero/Connect-MS365 #> $InstallCommand = "-Command &{ Install-Module -Name $Module -Scope AllUsers -Force}" $InstallChoice = Read-Host -Prompt "Module $Module is not present or update was triggered. Perform Install? (Y/n)" If (($InstallChoice.Length -eq 0) -or ($InstallChoice.ToLower() -eq "y")) { try { Start-Process -Filepath powershell -ArgumentList $InstallCommand -Verb RunAs -Wait } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not install Module $ModuleName.`n$ErrorMessage" -Category ConnectionError Break } continue } } function Set-WindowTitle { [CmdletBinding()] param ( [Parameter(Mandatory=$True,Position=1)] [String] $Service ) <# .SYNOPSIS Sets Window Title if connection was successful. .DESCRIPTION Sets Window Title if connection was successful. Adds prefix if not already set. .PARAMETER Service Name of service to put in Window title. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE Set-WindowTitle -Service MSOL .LINK http://github.com/blindzero/Connect-MS365 #> If (($host.ui.RawUI.WindowTitle) -notlike "*$ServiceItem*" ) { If (($host.ui.RawUI.WindowTitle) -notlike "*Connected To:*") { $host.ui.RawUI.WindowTitle += " -- Connected To: $ServiceItem" } Else { $host.ui.RawUI.WindowTitle += " || $ServiceItem" } } } function Test-MS365Module { [CmdletBinding()] param ( # service module to be tested, must be known service [Parameter(Mandatory=$True,Position=1)] [String] $Module ) <# .SYNOPSIS Checks if a module of a given service to connect is installed. .DESCRIPTION Checks if a module of a given service to connect is installed. Service name needs to be passed. .PARAMETER Module Name of module to check installation. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE Test-MS365Module -Module MSOnline .LINK http://github.com/blindzero/Connect-MS365 #> # Set Splatting argument list for Get-Module used to determine if module is existing $GetModulesSplat = @{ ListAvailable = $True Verbose = $False } # Finding installed module, will be $null if not available on system $ModuleInstalled = (Get-Module @GetModulesSplat -Name $ModuleFindString) # Extracting Version of installed module if ($ModuleInstalled) { $ModuleInstalledVer = $ModuleInstalled.Version.ToString() } # Finding available module online $ModuleAvailable = (Find-Module -Name $ModuleFindString -ErrorAction SilentlyContinue) # Extracting Version of available module online if ($ModuleAvailable) { $ModuleAvailableVer = $ModuleAvailable.Version.ToString() } # initialize $TestResult $TestResult = $Null # return $false if module is not installed If ($null -eq $ModuleInstalled) { Write-Verbose "$ModuleName was not found." $TestResult = $False } Else { # otherwise compare installed and available version If ($ModuleInstalledVer -lt $ModuleAvailableVer) { # if newer version is available online prompt for update do { $confirm = Read-Host -Prompt "New $ModuleName version $ModuleAvailableVer is available (installed: $ModuleInstalledVer). Update? [Y/n]" if ($confirm.Length -eq 0) { $confirm = "y" } } while (($confirm.ToLower() -ne "n") -and ($confirm.ToLower() -ne "y")) # if confirmed ... If (($confirm.Length -eq 0) -or ($confirm.toLower() -eq "y")) { Write-Verbose "Updating Module $ModuleName from $ModuleInstalledVer to $ModuleAvailableVer" # return $False to be catched and update triggered $TestResult = $False } # if not confimed only do verbose logging and return true as update is optional Else { Write-Verbose "Skipping update of $ModuleName" $TestResult = $True } } Else { Write-Verbose "$ModuleName is latest available version $ModuleAvailableVer" $TestResult = $True } } return [Bool]$TestResult } function Connect-AAD { [CmdletBinding()] param ( [Parameter(Mandatory=$False,Position=1)] [PSCredential] $Credential ) <# .SYNOPSIS Connects to Microsoft Azure ActiveDirectory (AzureAD / AAD) service. .DESCRIPTION Connects to Microsoft Azure ActiveDirectory (AzureAD / AAD) service. .PARAMETER Credential PSCredential object containing user credentials. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE PS> Connect-AAD -Credential $Credential .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available Install-MS365Module -Service $ServiceItem } try { Connect-AzureAD | Out-Null } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } function Connect-AZ { [CmdletBinding()] param ( ) <# .SYNOPSIS Connects to Microsoft Azure platform. .DESCRIPTION Connects to Microsoft Azure platform. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE PS> Connect-AZ -Credential $Credential .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available Install-MS365Module -Module $ModuleName } try { Connect-AzAccount | Out-Null } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } function Connect-EOL { [CmdletBinding()] param ( [Parameter(Mandatory=$False,Position=1)] [PSCredential] $Credential ) <# .SYNOPSIS Connects to Microsoft Exchange Online service. .DESCRIPTION Connects to Microsoft Exchange Online service. .PARAMETER Credential PSCredential object containing user credentials. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE PS> Connect-EOL -Credential $Credential .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available Install-MS365Module -Module $ModuleName } try { Connect-ExchangeOnline -ShowProgress $true } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } function Connect-MSOL { [CmdletBinding()] param ( [Parameter(Mandatory=$False,Position=1)] [PSCredential] $Credential ) <# .SYNOPSIS Connects to Microsoft Online service. .DESCRIPTION Connects to Microsoft Online service / Azure ActiveDirectory v1 .PARAMETER Credential PSCredential object containing user credentials. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE PS> Connect-MSOL -Credential $Credential .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available Install-MS365Module -Module $ModuleName } try { Connect-MsolService -ErrorAction Stop } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } function Connect-S4B { [CmdletBinding()] param ( [Parameter(Mandatory = $False, Position = 1)] [PSCredential] $Credential ) <# .SYNOPSIS Connects to Microsoft Skype for Business Online service. .DESCRIPTION Connects to Microsoft Skype for Business Online service. .PARAMETER Credential PSCredential object containing user credentials. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE PS> Connect-S4B -Credential $Credential .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available #S4B module is not available on https://www.powershellgallery.com - must be installed manually Write-Error -Message "SkypeOnlineConnector module is not installed.`nPlease download and install it manually from https://www.microsoft.com/en-us/download/details.aspx?id=39366" -Category NotInstalled return #Install-MS365Module -Service $ServiceItem } try { Import-Module SkypeOnlineConnector $sfbSession = New-CsOnlineSession Import-PSSession $sfbSession } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } function Connect-SCC { [CmdletBinding()] param ( [Parameter(Mandatory=$False,Position=1)] [PSCredential] $Credential ) <# .SYNOPSIS Connects to Microsoft Security and Comliance Center. .DESCRIPTION Connects to Microsoft Security and Comliance Center. .PARAMETER Credential PSCredential object containing user credentials. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE PS> Connect-SCC -Credential $Credential .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available Install-MS365Module -Module $ModuleName } try { Connect-IPPSSession } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } function Connect-SPO { [CmdletBinding()] param ( [Parameter(Mandatory=$True,Position = 1)] [String] $SPOOrgUrl, [Parameter(Mandatory=$False,Position = 2)] [PSCredential] $Credential ) <# .SYNOPSIS Connects to Microsoft SharePoint Online service. .DESCRIPTION Connects to Microsoft SharePoint Online service. .PARAMETER SPOOrgUrl String object containing the SharePoint Online organization admin Url. .PARAMETER Credential PSCredential object containing user credentials. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE Description: Connect to SharePoint Online organisation MyName PS> Connect-SPO -SPOOrgName https://myname-admin.sharepoint.com .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available Install-MS365Module -Module $ModuleName } try { Connect-SPOService -Url $SPOOrgUrl -ErrorAction Stop | Out-Null } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } function Connect-Teams { [CmdletBinding()] param ( [Parameter(Mandatory=$False,Position=1)] [PSCredential] $Credential ) <# .SYNOPSIS Connects to Microsoft Teams service. .DESCRIPTION Connects to Microsoft Teams service. .PARAMETER Credential PSCredential object containing user credentials. .INPUTS None. You cannot pipe objects to Add-Extension. .OUTPUTS // <OBJECTTYPE>. TBD. .EXAMPLE PS> Connect-Teams -Credential $Credential .LINK http://github.com/blindzero/Connect-MS365 #> # testing if module is available while (!(Test-MS365Module -Module $ModuleName)) { # and install if not available Install-MS365Module -Module $ModuleName } try { Connect-MicrosoftTeams -ErrorAction Stop | Out-Null } catch { $ErrorMessage = $_.Exception.Message Write-Error -Message "Could not connect to $ServiceItem.`n$ErrorMessage" -Category ConnectionError Break } # set service name into window title if successfully connected Set-WindowTitle -Service $ServiceItem } |