Azure Template Update

Author: FriedrichWeinmann

templates/PSFModule/þnameþ.psd1

@@ -1,6 +1,6 @@
 @{
 	# Script module or binary module file associated with this manifest
-	ModuleToProcess = 'þnameþ.psm1'
+	RootModule = 'þnameþ.psm1'
 
 	# Version number of this module.
 	ModuleVersion = '1.0.0'

templates/PSFProject/azFunctionResources/clientModule/function.ps1

@@ -0,0 +1,10 @@
+function %functionname%
+{
+	%parameter%
+	
+	process
+	{
+		$invokeParameters = Get-InternalConnectionData -Method '%method%' -Parameter $PSBoundParameters -FunctionName '%condensedname%'
+		Invoke-RestMethod @invokeParameters
+	}
+}

templates/PSFProject/azFunctionResources/clientModule/functions/Connect-þnameþ.ps1

@@ -0,0 +1,62 @@
+function Connect-þnameþ
+{
+<#
+	.SYNOPSIS
+		Configures the connection to the þnameþ Azure Function.
+	
+	.DESCRIPTION
+		Configures the connection to the þnameþ Azure Function.
+	
+	.PARAMETER Uri
+		Url to connect to the þnameþ Azure function.
+	
+	.PARAMETER UnprotectedToken
+		The unencrypted access token to the þnameþ Azure function. ONLY use this from secure locations or non-sensitive functions!
+	
+	.PARAMETER ProtectedToken
+		An encrypted access token to the þnameþ Azure function. Use this to persist an access token in a way only the current user on the current system can access.
+	
+	.PARAMETER Register
+		Using this command, the module will remember the connection settings persistently across PowerShell sessions.
+		CAUTION: When using unencrypted token data (such as specified through the -UnprotectedToken parameter), the authenticating token will be stored in clear-text!
+	
+	.EXAMPLE
+		PS C:\> Connect-þnameþ -Uri 'https://demofunctionapp.azurewebsites.net/api/'
+	
+		Establishes a connection to þnameþ
+#>
+	[CmdletBinding()]
+	param (
+		[string]
+		$Uri,
+		
+		[string]
+		$UnprotectedToken,
+		
+		[System.Management.Automation.PSCredential]
+		$ProtectedToken,
+		
+		[switch]
+		$Register
+	)
+	
+	process
+	{
+		if (Test-PSFParameterBinding -ParameterName UnprotectedToken)
+		{
+			Set-PSFConfig -Module 'þnameþ' -Name 'Client.UnprotectedToken' -Value $UnprotectedToken
+			if ($Register) { Register-PSFConfig -Module 'þnameþ' -Name 'Client.UnprotectedToken' }
+		}
+		if (Test-PSFParameterBinding -ParameterName Url)
+		{
+			Set-PSFConfig -Module 'þnameþ' -Name 'Client.Uri' -Value $Uri
+			if ($Register) { Register-PSFConfig -Module 'þnameþ' -Name 'Client.Uri' }
+		}
+		if (Test-PSFParameterBinding -ParameterName ProtectedToken)
+		{
+			Set-PSFConfig -Module 'þnameþ' -Name 'Client.ProtectedToken' -Value $ProtectedToken
+			if ($Register) { Register-PSFConfig -Module 'þnameþ' -Name 'Client.ProtectedToken' }
+		}
+		
+	}
+}

templates/PSFProject/azFunctionResources/clientModule/internal/configurations/connection.ps1

@@ -0,0 +1,3 @@
+Set-PSFConfig -Module 'þnameþ' -Name 'Client.Uri' -Value $null -Initialize -Validation 'string' -Description "Url to connect to the þnameþ Azure function"
+Set-PSFConfig -Module 'þnameþ' -Name 'Client.UnprotectedToken' -Value '' -Initialize -Validation 'string' -Description "The unencrypted access token to the þnameþ Azure function. ONLY use this from secure locations or non-sensitive functions!"
+Set-PSFConfig -Module 'þnameþ' -Name 'Client.ProtectedToken' -Value $null -Initialize -Validation 'credential' -Description "An encrypted access token to the þnameþ Azure function. Use this to persist an access token in a way only the current user on the current system can access."

templates/PSFProject/azFunctionResources/clientModule/internal/functions/Get-InternalConnectionData.ps1

@@ -0,0 +1,70 @@
+function Get-InternalConnectionData
+{
+<#
+	.SYNOPSIS
+		Creates parameter hashtables for Invoke-RestMethod calls.
+	
+	.DESCRIPTION
+		Creates parameter hashtables for Invoke-RestMethod calls.
+		This is the main abstraction layer for public functions.
+	
+	.PARAMETER Method
+		The Rest Method to use when calling this function.
+	
+	.PARAMETER Parameters
+		The PSBoundParameters object. Will be passed online using PowerShell Serialization.
+	
+	.PARAMETER FunctionName
+		The name of the Azure Function to call.
+		This should always be the condensed name of the function.
+#>
+	[CmdletBinding()]
+	param (
+		[string]
+		$Method,
+		
+		$Parameters,
+		
+		[string]
+		$FunctionName
+	)
+	
+	process
+	{
+		try { $uri = '{0}{1}' -f (Get-PSFConfigValue -FullName 'þnameþ.Client.Uri' -NotNull), $FunctionName }
+		catch { $PSCmdlet.ThrowTerminatingError($_) }
+		$header = @{ }
+		
+		#region Authentication
+		$unprotectedToken = Get-PSFConfigValue -FullName 'þnameþ.Client.UnprotectedToken'
+		$protectedToken = Get-PSFConfigValue -FullName 'þnameþ.Client.ProtectedToken'
+		
+		$authenticationDone = $false
+		if ($protectedToken -and -not $authenticationDone)
+		{
+			$uri += '?code={0}' -f $protectedToken.GetNetworkCredential().Password
+			$authenticationDone = $true
+		}
+		if ($unprotectedToken -and -not $authenticationDone)
+		{
+			$uri += '?code={0}' -f $unprotectedToken
+			$authenticationDone = $true
+		}
+		if (-not $authenticationDone)
+		{
+			throw "No Authentication configured!"
+		}
+		#endregion Authentication
+		
+		
+		@{
+			Method  = $Method
+			Uri	    = $uri
+			Headers = $header
+			Body    = @{
+				__SerializedParameters = ($Parameters | ConvertTo-PSFHashtable | ConvertTo-PSFClixml)
+				__PSSerialize		   = $true
+			}
+		}
+	}
+}

templates/PSFProject/azFunctionResources/clientModule/moduleroot.psm1

@@ -0,0 +1,14 @@
+$script:ModuleRoot = $PSScriptRoot
+
+foreach ($file in (Get-ChildItem -Path "$script:ModuleRoot\internal\configurations" -Recurse -Filter '*.ps1'))
+{
+	. $file.FullName
+}
+foreach ($file in (Get-ChildItem -Path "$script:ModuleRoot\internal\functions" -Recurse -Filter '*.ps1'))
+{
+	. $file.FullName
+}
+foreach ($file in (Get-ChildItem -Path "$script:ModuleRoot\functions" -Recurse -Filter '*.ps1'))
+{
+	. $file.FullName
+}

templates/PSFProject/azFunctionResources/functionOverride/Get-Example.ps1

@@ -0,0 +1,36 @@
+function Get-Example
+{
+	<#
+		.NOTES
+			This file will be used to override the auto-generated CLIENT MODULE function implementation.
+		
+			Using the vsts-createFunctionClientModule.ps1 task script, you can autogenerate a client module.
+			That module can be used to connect to the published Azure Function Module.
+			However sometimes you may want to override the default client function for a given command,
+			in order to better customize the way it behaves.
+		
+			Creating a ps1 file with the name of the specific function in this folder will use this file,
+			rather than creating a default copy.
+		
+			NOTE:
+			There will be no further automatic change detection!
+			If you later update the Azure Function, you need to manually update the client function as well.
+	#>
+	[CmdletBinding()]
+	Param (
+	
+	)
+	
+	begin
+	{
+		
+	}
+	process
+	{
+	
+	}
+	end
+	{
+	
+	}
+}

templates/PSFProject/azFunctionResources/functionOverride/Get-Example.psd1

@@ -1,4 +1,7 @@
 @{
-	# Setting this to $true will cause the azure function to use Json serialization, rather than PowerShell Serialization
-	'NoSerialize' = $true
+	# Override the rest methods used for the API endpoint
+	# RestMethods = 'delete'
+	
+	# Override inclusion into client module
+	# NoClientFunction
 }

templates/PSFProject/azFunctionResources/profileFunctions/Convert-AzureFunctionParameter.ps1

@@ -16,6 +16,7 @@
 	
 		Converts the $request object into a regular hashtable.
 #>
+	[OutputType([System.Collections.Hashtable])]
 	[CmdletBinding()]
 	param (
 		$Request

templates/PSFProject/azFunctionResources/run.ps1

@@ -5,6 +5,12 @@
 )
 
 $parameters = Convert-AzureFunctionParameter -Request $Request
+if ($parameters.__PSSerialize)
+{
+	$usePSSerialize = $true
+	$parameters.Remove('__PSSerialize')
+}
+else { $usePSSerialize = $false }
 
 try { $data = %functionname% @parameters }
 catch
@@ -13,7 +19,4 @@ catch
 	return
 }
 
-# This is automatically updated by the build script if there is a custom override for function
-$serialize = $true
-
-Write-AzureFunctionOutput -Value $data -Serialize:$serialize
+Write-AzureFunctionOutput -Value $data -Serialize:$usePSSerialize