Merge pull request #200 from PowershellFrameworkCollective/azureFunctionTemplate

AzureFunction template update

Author: FriedrichWeinmann

PSModuleDevelopment/PSModuleDevelopment.psd1

@@ -5,7 +5,7 @@
 
 	# Version number of this module.
 
-	ModuleVersion = '2.2.11.163'
+	ModuleVersion = '2.2.11.168'
 
   # ID used to uniquely identify this module
 	GUID = '37dd5fce-e7b5-4d57-ac37-832055ce49d6'

PSModuleDevelopment/changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.2.11.168 (2024-05-31)
+
++ Upd: Template AzureFunction - added config option to override http Endpoint methods (#198)
++ Upd: Template AzureFunction - updated host.json to include some default headers (#197)
++ Fix: Template AzureFunction - build script ignores some overrides due to typo (#199)
++ Fix: Template AzureFunction - build fails when executing without the String module loaded (#196)
++ Fix: Template MiniModule - Automatically adds wrong github sponsor accountname
+
 ## 2.2.11.163 (2024-02-25)
 
 + New: Template ApplockerPipeline - A project that can be used to generate AppLocker policies across environments

templates/AzureFunction/PSMDTemplate.ps1

@@ -1,6 +1,6 @@
 @{
     TemplateName         = 'AzureFunction'
-    Version              = "2.0.0"
+    Version              = "2.0.5"
     AutoIncrementVersion = $true
     Tags                 = 'azure', 'function'
     Author               = 'Friedrich Weinmann'

templates/AzureFunction/build/build.config.psd1

@@ -22,5 +22,9 @@
 		AuthLevelOverrides = @{
 			# 'Set-Foo' = 'anonymous'
 		}
+		Methods = @('get', 'post')
+		MethodOverrides = @{
+			# 'Set-Foo' = 'delete'
+		}
 	}
 }

templates/AzureFunction/build/build.ps1

@@ -28,25 +28,29 @@ $commands = Get-ChildItem -Path "$($buildFolder.FullName)/modules/þnameþ/Funct
 Update-ModuleManifest -Path "$($buildFolder.FullName)/modules/þnameþ/þnameþ.psd1" -FunctionsToExport $commands
 
 # Generate Http Trigger
-$httpCode = Get-Content -Path "$PSScriptRoot\functionHttp\run.ps1" | Join-String "`n"
-$httpConfig = Get-Content -Path "$PSScriptRoot\functionHttp\function.json" | Join-String "`n"
+$httpCode = Get-Content -Path "$PSScriptRoot\functionHttp\run.ps1" | Join-String -Separator "`n"
+$httpConfig = Get-Content -Path "$PSScriptRoot\functionHttp\function.json" | Join-String -Separator "`n"
 foreach ($command in Get-ChildItem -Path "$workingDirectory\þnameþ\functions\httpTrigger" -Recurse -File -Filter *.ps1) {
 	$authLevel = $config.HttpTrigger.AuthLevel
-	if ($config.HttpTrigger.AuthLevelOverride.$($command.BaseName)) {
-		$authLevel = $config.HttpTrigger.AuthLevelOverride.$($command.BaseName)
+	if ($config.HttpTrigger.AuthLevelOverrides.$($command.BaseName)) {
+		$authLevel = $config.HttpTrigger.AuthLevelOverrides.$($command.BaseName)
+	}
+	$methods = $config.HttpTrigger.Methods
+	if ($config.HttpTrigger.MethodOverrides.$($command.BaseName)) {
+		$methods = $config.HttpTrigger.MethodOverrides.$($command.BaseName)
 	}
 	$endpointFolder = New-Item -Path $buildFolder.FullName -Name $command.BaseName -ItemType Directory
 	$httpCode -replace '%COMMAND%',$command.BaseName | Set-Content -Path "$($endpointFolder.FullName)\run.ps1"
-	$httpConfig -replace '%AUTHLEVEL%', $authLevel | Set-Content -Path "$($endpointFolder.FullName)\function.json"
+	$httpConfig -replace '%AUTHLEVEL%', $authLevel -replace '%METHODS%', ($methods -join '", "') | Set-Content -Path "$($endpointFolder.FullName)\function.json"
 }
 
 # Generate Timer Trigger
-$timerCode = Get-Content -Path "$PSScriptRoot\functionTimer\run.ps1" | Join-String "`n"
-$timerConfig = Get-Content -Path "$PSScriptRoot\functionTimer\function.json" | Join-String "`n"
+$timerCode = Get-Content -Path "$PSScriptRoot\functionTimer\run.ps1" | Join-String -Separator "`n"
+$timerConfig = Get-Content -Path "$PSScriptRoot\functionTimer\function.json" | Join-String -Separator "`n"
 foreach ($command in Get-ChildItem -Path "$workingDirectory\þnameþ\functions\timerTrigger" -Recurse -File -Filter *.ps1) {
 	$schedule = $config.TimerTrigger.Schedule
-	if ($config.TimerTrigger.ScheduleOverride.$($command.BaseName)) {
-		$schedule = $config.TimerTrigger.ScheduleOverride.$($command.BaseName)
+	if ($config.TimerTrigger.ScheduleOverrides.$($command.BaseName)) {
+		$schedule = $config.TimerTrigger.ScheduleOverrides.$($command.BaseName)
 	}
 	$endpointFolder = New-Item -Path $buildFolder.FullName -Name $command.BaseName -ItemType Directory
 	$timerCode -replace '%COMMAND%',$command.BaseName | Set-Content -Path "$($endpointFolder.FullName)\run.ps1"

templates/AzureFunction/build/functionHttp/function.json

@@ -6,8 +6,7 @@
       "direction": "in",
       "name": "Request",
       "methods": [
-        "get",
-        "post"
+        "%METHODS%"
       ]
     },
     {

templates/AzureFunction/function/host.json

@@ -1,6 +1,23 @@
 {
-  "version": "2.0",
-  "managedDependency": {
-    "Enabled": true
-  }
+	"version": "2.0",
+	"extensions": {
+		"http": {
+			"routePrefix": "api",
+			"customHeaders": {
+				"Content-Security-Policy": "default-src 'self'",
+				"Permissions-Policy": "geolocation=()",
+				"X-Frame-Options": "SAMEORIGIN",
+				"Strict-Transport-Security": "max-age=31536000; includeSubDomains",
+				"X-Content-Type-Options": "nosniff",
+				"Referrer-Policy": "no-referrer"
+			}
+		}
+	},
+	"managedDependency": {
+		"enabled": true
+	},
+	"extensionBundle": {
+		"id": "Microsoft.Azure.Functions.ExtensionBundle",
+		"version": "[3.*, 4.0.0)"
+	}
 }

templates/MiniModule/.github/FUNDING.yml

@@ -1,7 +1,6 @@
 # These are supported funding model platforms
 
-github: 
-  FriedrichWeinmann
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username