PowerShell Tips to Write By
PowerShell Tips to Write By
Building better PowerShell scripts one tip at a time
About the Book
Hi,
I'm Adam Bertram. I've been writing PowerShell for over ten years. I was one of the first Microsoft PowerShell MVPs. I am a published author on PowerShell, avid learn PowerShell blogger and have authored dozens of courses on PowerShell. I'm a bit obsessed with this language.
For this eBook, I've teamed up with Bryce Mcdonald, another PowerShell expert. We're bringing you an eBook that covers hundreds of tips and tricks to teach you how to write PowerShell code.
You don't have to waste time watching dozens of courses or poring over hundreds of articles to write better PowerShell. You'll never catch all the tips anyway.
We've boiled down our collective PowerShell experience and knowledge into easily-referenceable, bite-sized form. We've also included dozens of tips from the PowerShell community! This eBook is the biggest collection of tips available to help you write better PowerShell scripts.
-------------------------------------------------
Learn Best Practices
PowerShell is flexible to the developer (maybe a little too flexible). There are dozens of ways to get tasks done. But how do you know it's the best way? See how PowerShell experts solve PowerShell problems in snackable, knowledge nuggets. Don't get immediately bogged down in the specifics.
Discover New PowerShell Articles, Courses, Videos and More
Rather than diving deep into topics, we cover all the best PowerShell tips and tricks in tip form. Not only will you see what's possible, but we'll also give you a link to a hand-picked resource (paid or free). These resources will cover a topic in-depth — no more Googling around for how-to articles!
Think of this book as your gateway to being a PowerShell pro. Discover new resources you may not know exist that go in-depth on topics you'd like to learn more about.
Build Better PowerShell Code One Tip at a Time
Use this book as a reference. Use the book as a guide to help you remember the basics or learn new tricks. Encourage co-workers to buy this book to ensure your entire team writes better code. Learn better ways to write PowerShell one tip at a time!
About the Author
Bundles that include this book
About the Contributors
Table of Contents
- About This Book
- About the Authors
- Feedback
-
Introduction
- Tip Format
-
Do The Basics
- Plan Before you Code
- Don’t Reinvent the Wheel
- Build Functions as Building Blocks
- Build Re-usable Tools
- Don’t Focus Purely on Peformance
- Build Pester tests
- Implement Error handling
- Build Manageable Code
- Don’t Skimp on Security
- Log Script Activity
- Parameterize Everything
- Limit Script and Function Input
- Maintain Coding Standards
- Code in Context
- Return Informative Output
- Understand Your Code
- Use Version Control
- Write for Cross Platform
- Write for the Next Person
- Use a Code Editor
-
Don’t Reinvent the Wheel
- Use Community Modules
- Leverage Others’ work
-
Plan Before you Code
- Write Comments Before Coding
- Use your Code as a Todo List
-
Create Building Blocks with Functions
- Write Functions with One, Single Goal
- Build Functions with Pipeline Support
- Save Commonly-Used, Interactive Functions to Your Profile
-
Parameterize Everything
- Don’t Hardcode. Always Use Parameters
- Use Parameter Sets When All Parameters Should Not be Used at Once
- Use a PSCredential Object Rather than a Separate Username and Password
-
Log Script Activity
- Use a Logging Function
- Clean up Verbose Messages
-
Build with Manageability in Mind
- DRY: Don’t Repeat Yourself
- Don’t Store Configuration Items in Code
- Always Remove Dead Code
-
Be Specific
- Use Strict Mode
- Don’t Ignore Errors
- Validate Input Parameters
- Explicitly Define Parameter Types
- Enforce Mandatory Parameters
- Use the #requires Statement
-
Write for the Next Person
- Give your Variables Meaningful Names
- String Substitution
- Don’t use Aliases in a Script
- Put functions in Alphabetical Order in a Module
- Explain Regular Expressions with Comments
- Write Comment-Based Help
- Weigh the Difference Between Performance and Readability
-
Handle Errors Gracefully
- Force Hard-Terminating Errors
- Avoid Using $?
-
Copy
$Error[0]to your Own Variable
-
Don’t Skimp on Security
- Sign Scripts
- Use Scriptblock Logging
- Never Store Sensitive Information in Clear Text in Code
- Don’t use Invoke-Expression
- Use PowerShell Constrained Language Mode
-
Stick to PowerShell
- Use Native PowerShell Where Possible
- Use PowerShell standard cmdlet naming
-
Build Tools
- Code for Portablity
- Wrap Command-Line Utilities in Functions
- Force Functions to Return Common Object Types
- Ensure Module Functions Cover all the Verbs
-
Return Stndardized, Informative Output
- Use Progress Bars Wisely
- Leave the Format Cmdlets to the Console
- Use Write-Verbose
- Use Write-Information
- Ensure a Command Returns One Type of Object
- Only Return Necessary Information to the Pipeline
-
Build Scripts for Speed
- Use an ArrayList or GenericList .NET Class when Elements Need to be Added to an Array
- Use a Regular Expression to Search Multiple String Values
-
Don’t use
Write-Hostin Bulk - Don’t use the Pipeline
-
Use the
.foreach()and.where()Methods - Use Parallel Processing
- Use the .NET StreamReader Class When Reading Large Text Files
-
Build Tests
- Learn the Pester Basics
- Leverage Infrastructure Tests
- Automate Pester Tests
- Use PSScriptAnalyzer
-
Miscellaneous Tips
- Write for Cross Platform
- Don’t Query the Win32_Product CIM Class
- Create a Shortcut to run PowerShell as Administrator
- Store ‘Formatable’ Strings for Use Later
- Use Out-GridView for GUI-based Sorting and Filtering
- Don’t Make Automation Scripts Interactive
- Summary
- Release Notes
Authors have earned$10,318,275writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Continuous Delivery Pipelines
Dave FarleyThis practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.
- #2
Top 20 Digital Health Trends For The Near Future
Dr. Bertalan MeskoDigital technology could help transform unsustainable healthcare systems, provide cheaper, faster, and more effective solutions for diseases – and could lead to healthier individuals living in healthier communities.
In this book, we analyze the top 20 trends shaping the future of healthcare, and what they all look like in practice.
- #3
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
- #4
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
- #5
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
- #6
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
- #7
CCIE Service Provider Version 4 Written and Lab Exam Comprehensive Guide
Nicholas RussoThe service provider landscape has changed rapidly over the past several years. Networking vendors are continuing to propose new standards, techniques, and procedures for overcoming new challenges while concurrently reducing costs and delivering new services. Cisco has recently updated the CCIE Service Provider track to reflect these changes; this book represents the author's personal journey in achieving that certification.
- #8
Hacking your way around in Emacs
Marcin BorkowskiThis is an intermediate textbook on Emacs Lisp. Learn how to write you own commands and make Emacs truly your editor, suited to your needs!
- #9
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #10
Visualise, document and explore your software architecture
Simon BrownA short guide to visualising, documenting and exploring your software architecture.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #4
9 Books-Bundle: Shut Up and Code!
9 Books
"Shut up and code." Laughter in the audience. The hacker had just plugged in his notebook and started sharing his screen to present his super-smart Python script. "Shut up and code" The letters written in a white literal coding font on black background was the hackers' home screen background mantra. At the time, I was a first-year computer... - #7
Practical Foundations of Debugging, Disassembling, Reversing
2 Books
The books teach assembly language foundations necessary for deep debugging and program reconstruction. They are useful for: - Software technical support and escalation engineers; - Software engineers coming from different backgrounds, OS, and programming/debugging environments; - Software testers; - C/C++ software engineers without assembly... - #8
Software Architecture and Design Practice Reference
2 Books
Dive deeper in Software Architecture with the Design Practice Reference. Learn all about software architecture and design from the books in this bundle:Software Architecture covers topics from quality attributes to designing and modeling components, interfaces, connectors, and containers, all the way to services and microservices. The Design... - #10
Mastering Containers
2 Books
Docker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes!
