From 6608efff65e31b8e470272495d9eff179bfa9bd2 Mon Sep 17 00:00:00 2001 From: Lee Schuenemeyer Date: Tue, 18 May 2021 12:59:26 -0500 Subject: [PATCH] Updated Readme with defined steps - Added a new heading for the Azure prerequisites to separate them from the local installation process - Added wording for the required level of permissions to the Azure subscription - Added "force" and "accept/yes" switch options to Chocolatey installations to expedite the installation by removing the need to accept each install's confirmations - Created a dedicated step to install the PowerShell Az (Azure) modules to make the requirement clearer to the reader - Added a "force" parameter to the Az module installation to expedite the installation --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 16068d4..f7472ce 100644 --- a/README.md +++ b/README.md @@ -136,15 +136,15 @@ Failed to register free address space The UpdateAddressSpaceTimer Azure Function is a timer function which is scheduled to run every day at 9:30 AM. If you want to change the schedule please change the [function.json](https://github.com/stefanstranger/AIPAS/blob/master/src/function/UpdateAddressSpaceTimer/function.json) schedule configuration. -## Requirements +## Azure Requirements -Azure Subscription with: +An Azure Subscription with at least contributer rights containing the following: -- Resource Group -- Azure Storage Account and Storage Table -- Azure Function +- a Resource Group +- an Azure Storage Account and Storage Table +- an Azure Function -## Local development +## Local development requirements If you want to further develop or test AIPAS you need to install the following prerequisites on your Windows development machine. @@ -160,15 +160,15 @@ If you installed [Chocolatey](https://chocolatey.org/) (a Windows Apt-Get kinda ```PowerShell # Install Git -choco install git +choco install git -fy # Install VSCode -choco install vscode +choco install vscode -fy # Install Azure Function Core Tools -choco install azure-functions-core-tools-3 +choco install azure-functions-core-tools-3 -fy # Install PowerShell Core -choco install pwsh +choco install pwsh -fy # Install HttpMaster -choco install httpmaster-express +choco install httpmaster-express -fy ``` ### Clone AIPAS Repository @@ -177,7 +177,7 @@ choco install httpmaster-express git clone https://github.com/stefanstranger/AIPAS.git ``` -### Install PowerShell Modules +### Install PowerShell Modules via included Bootstrap.ps1 script After cloning the Git Repository you can use the bootstrap.ps1 script to install the required PowerShell modules. @@ -188,12 +188,14 @@ The following PowerShell Modules need to be installed: - InvokeBuild - Pester - PlatyPS -- Az PowerShell modules* - -\* The installation of the Az PowerShell modules are not part of the bootstrap.ps1 script. If you have not installed these PowerShell modules run Install-Module -Name Az on your development machine. +### Install Az PowerShell module +The installation of the Az PowerShell modules are not part of the bootstrap.ps1 script. To install or upgrade the Az PowerShell module, run the follwing in a elevated permisions PowerShell session: +```PowerShell +Install-Module -Name Az -Force +``` ### Deploy Azure Storage Table Within the Git Repository there are Azure Resource Manager Template files that can be used to deploy a new Resource Group with an Azure Storage Table.