design-guidelines

Azure PowerShell Design Guidelines

In this folder, you will find best practices and design guidelines for different components of Azure PowerShell.

Table of contents

• Cmdlet Best Practices
  • Cmdlet Naming Conventions
  • Output Type
  • ShouldProcess
  • AsJob
  • Required Parameter Sets
• Module Best Practices
  • Module Metadata
  • Module Dependencies
• Parameter Best Practices
  • Parameter Guidelines
    • Parameter Naming Conventions
    • Parameter Types
    • Argument Completers
  • Parameter Set Guidelines
    • Parameter Set Naming Conventions
    • Attribute Guidelines
• Piping Best Practices
  • Piping in PowerShell
    • Understanding Piping
  • Piping in Azure PowerShell
    • Using the -InputObject Parameter
    • Using the -ResourceId Parameter
    • Full examples
• ShouldProcess and ConfirmImpact
  • ShouldProcess
  • ConfirmImpact