Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.75 KB

install-instructions.md

File metadata and controls

53 lines (37 loc) · 1.75 KB

Install instructions

Prerequisites

  • Windows PowerShell 5.1 with .NET Framework 4.7.2+ or
  • PowerShell Core 6.0 or greater on Windows, macOS and Linux

For a list of platforms that PowerShell Core is supported on see.

The following modules are required for PSRule.Rules.Azure to work:

  • PSRule
  • Az.Accounts
  • Az.Resources
  • Az.Security
  • Az.Sql
  • Az.Storage
  • Az.Websites

The required version of each module will automatically be installed along-side PSRule.Rules.Azure when using Install-Module or Update-Module cmdlets.

Getting the modules

Currently, only a pre-release version of the module is available. See below for instructions to install the pre-release version.

Install from PowerShell Gallery for all users (requires permissions):

# Install module
Install-Module -Name 'PSRule.Rules.Azure' -Repository PSGallery;

Install from PowerShell Gallery for current user only:

# Install module
Install-Module -Name 'PSRule.Rules.Azure' -Repository PSGallery -Scope CurrentUser;

Save for offline use from PowerShell Gallery:

# Save module, in the .\modules directory
Save-Module -Name 'PSRule', 'PSRule.Rules.Azure', 'Az.Accounts', 'Az.StorageSync', 'Az.Security', 'Az.Storage', 'Az.Websites', 'Az.Sql' -Path '.\modules';

For pre-release versions the -AllowPrerelease switch must be added when calling Install-Module or Save-Module.

To install pre-release module versions, upgrading to the latest version of PowerShellGet may be required. To do this use:

Install-Module -Name PowerShellGet -Repository PSGallery -Scope CurrentUser -Force