Downloaded 25 times
Uploaded byMichael Blumenthal (Microsoft MVP)
Best practices and tools for PowerShell and SharePoint Scripting SharePointFest SIA202
This document summarizes tools and best practices for PowerShell scripting for SharePoint. It discusses the Integrated Scripting Environment (ISE) for writing PowerShell scripts, decompiling SharePoint pages using tools like ILSpy, and following best practices like writing functions that announce themselves, adding comments, using verbs and nouns consistently in function names, and using source control. It also provides additional resources for learning PowerShell scripting.
Best practices and tools for PowerShell and SharePoint Scripting SharePointFest SIA202
- 1. SIA 202 Tools andBest Practices When PowerShell Scripting for SharePoint Michael Blumenthal PSC Group, LLC Mblumenthal@PSCListens.com
- 2. 2 Who is MichaelBlumenthal? Sr. Solution Architect at PSC Group CSPUG Co-Leader INETA Champ 2010-2012 19 years in IT Consulting 10 years working with SharePoint (2003,2007,2010, 2013)
- 3. 3 This is aboutyou Version of SharePoint? Admin, Developer, Both, Other? PowerShell experience? SharePoint experience? Unix experience? Scripting experience?
- 4.
- 5.
- 6. Tools ISE •Add Windows Feature PowerShellPlus - Idera •SP2010 focused PowerGui •Pro version Too PowerShell Studio - Sapien •Not Free Visual Studio 2012
- 7. 7 ISE, ISE Baby Microsoft’s AvailableSince POSH V2 • SP2010 -> POSH 2; SP2013 -> POSH 3 OS Feature
- 8. 8 You might haveto add the ISE
- 9.
- 10.
- 11. 11 PowerShell V3 ISE- for SP2013
- 12. 12 POSH vs theSharePoint Mgmt Shell POSH + SnapIn = SharePoint Management Shell
- 13.
- 14.
- 15. 15 PowerGUI Created for POSHv1 originally Free & large community support Lots of Add-ons • SCCS in Pro
- 16.
- 17.
- 18. 18 Idera’s PowerShell Plus Freewith ads for Idera’s other products Includes support for SP2010, but not 2013 Framework Dependecy…. Lots of features…. Bloated Overkill?
- 19.
- 20. 20 Sapien’s PowerShell Studio Trialrequires special trial license in a VM Does create a POSH Library
- 21.
- 22.
- 23. 23 Visual Studio 2012 Integrationwith TFS For SharePoint developers, tool of choice Add-ons available
- 24.
- 25.
- 26.
- 27.
- 28. One Trick Decompiling aSharePoint Page
- 29. 29 Use a Decompilerto see MSFT’s Code! ILSpy.net dotPeek (jetbrains) justDecompile (Telerik) .Net Reflector(RedGate) Others…
- 30.
- 31.
- 32.
- 33.
- 34.
- 35.
- 36. 36 Best Practices • Writeyour scripts as functions that announce themselves1 • Comment Your Functions2 • Follow the Verb-Noun pattern3 •Use Source Control4
- 37.
- 38. 38 Comment your functions <# .SYNOPSIS–a brief explanation of what the script or function does. .DESCRIPTION – a more detailed explanation of what the script or function does. .PARAMETER name – an explanation of a specific parameter. Replace name with the parameter name. You can have one of these sections for each parameter the script or function uses. .EXAMPLE – an example of how to use the script or function. You can have multiple .EXAMPLE sections if you want to provide more than one example. .NOTES – any miscellaneous notes on using the script or function. .LINK – a cross-reference to another help topic; you can have more than one of these. If you include a URL beginning with http:// or https://, the shell will open that URL when the Help command’s –online parameter is used. #>
- 39. 39 Use an Action-ThingFunction Name Add Backup Clear Connect Convert Copy Disable Disconnect Dismount Enable Etc… SPAppDeniedEndpoint SPClaimTypeMapping SPDiagnosticsPerformanceCo unter SPDistributedCacheServiceIns tance SPEduClassMember SPEduUser SPInfoPathUserAgent SPPluggableSecurityTrimmer SPProfileLeader SPProfileSyncConnection Etc… 42 verbs combined with 347 nouns to give us 799 cmdlets
- 40.
- 41. 41 Find custom commandsthis way Refresh the command list Actions you can take once you fill in parameters
- 42. 42 TFS for SourceCode Control
- 43.
- 44. 44 Compare Versions –the Diff
- 45. 45 More Good Ideas Alwaysread scripts before running them Make yours safe when others don’t Check for valid parameter values get-help about_Functions_Advanced_Parameters Do error handling get-help about_Try_Catch_Finally get-help about_CommonParameters -ErrorAction and -ErrorVariable Dispose of SPWebs and SPSites
- 46.
- 47.
- 48.
- 49.
- 50.
- 51.
- 52.
- 53.
- 54.
- 55. 55 Resources Summary MSFT Reverse EngineeringSharePoint Pages Bruce Payette’s Book v2 PowerShell Product Team Blog Community CodePlex: PSBBs (mine), CodePlex:SPInstaller My Blog at BlumenthalIT.Net Jeff Hicks , Gary LaPointe, Raymond Mitchell, Todd Klindt, SharePoint Jack POSHCODE.ORG, ScriptCenter, get- spscripts.com
- 56. 56 Improve your POSHScripts. Your future self will thank you. It’s Easy to Get Started! Learn & Use the PowerShell Syntax More Resources In Review…
- 57. 57 Questions & Raffle • MichaelBlumenthal SharePoint Architect PSC Group, LLC • MBlumenthal@psclistens.com • psclistens.com • www.cspug.org • Twitter: @MichaelBL • SPYam Thank you for your time today.