Merge pull request #93 from Splaxi/extend-sftp-with-key-support

Extend sftp with key support

Author: Splaxi

PsLogicAppExtractor/internal/arms/API.SftpWithSsh.Username.json

@@ -12,7 +12,8 @@
             "portNumber": "##PORTNUMBER##",
             "rootFolder": "##ROOTFOLDER##",
             "acceptAnySshHostKey": true,
-            "sshHostKeyFingerprint": ""
+            "sshHostKeyFingerprint": "",
+            "sshPrivateKey": "##SSHPRIVATEKEY##"
         },
         "displayName": "##NAME##",
         "customParameterValues": {},

PsLogicAppExtractor/internal/tasks/All/All.task.ps1

@@ -2388,7 +2388,8 @@ Task -Name "Set-Arm.Connections.ManagedApis.SftpWithSsh.Username.Advanced.AsArmO
             $rootPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_Rootfolder" -Value "$($_.Name)"
             $acceptPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_AcceptAnySshHostkey" -Value "$($_.Name)"
             $fingerPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_SshHostKeyFingerprint" -Value "$($_.Name)"
-            
+            $sshKeyPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_SshPrivateKey" -Value "$($_.Name)"
+
             $idPreSuf = Format-Name -Type "Connection" -Value "$($_.Name)"
             $displayPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_DisplayName" -Value "$($_.Name)"
 
@@ -2426,7 +2427,12 @@ Task -Name "Set-Arm.Connections.ManagedApis.SftpWithSsh.Username.Advanced.AsArmO
                 -Type "string" `
                 -Value "$fingerprint" `
                 -Description "The fingerprint that you expect during the initial communication with the Sftp server. ($($_.Name))"
-                
+
+            $armObj = Add-ArmParameter -InputObject $armObj -Name "$sshKeyPreSuf" `
+                -Type "SecureString" `
+                -Value "" `
+                -Description "The SSH private key used to authenticate against the Sftp server. Leave empty when using password authentication. ($($_.Name))"
+
             $armObj = Add-ArmParameter -InputObject $armObj -Name "$displayPreSuf" `
                 -Type "string" `
                 -Value $displayName `
@@ -2447,6 +2453,7 @@ Task -Name "Set-Arm.Connections.ManagedApis.SftpWithSsh.Username.Advanced.AsArmO
             $apiObj.Properties.ParameterValues.rootFolder = "[parameters('$rootPreSuf')]"
             $apiObj.Properties.ParameterValues.acceptAnySshHostKey = "[parameters('$acceptPreSuf')]"
             $apiObj.Properties.ParameterValues.sshHostKeyFingerprint = "[parameters('$fingerPreSuf')]"
+            $apiObj.Properties.ParameterValues.sshPrivateKey = "[parameters('$sshKeyPreSuf')]"
 
             # Update the api connection object type
             $_.Value.id -match "/managedApis/(.*)"

PsLogicAppExtractor/internal/tasks/Set-Arm.Connections.ManagedApis.SftpWithSsh.Username.Advanced.AsArmObject.task.ps1

@@ -60,7 +60,8 @@ Task -Name "Set-Arm.Connections.ManagedApis.SftpWithSsh.Username.Advanced.AsArmO
             $rootPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_Rootfolder" -Value "$($_.Name)"
             $acceptPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_AcceptAnySshHostkey" -Value "$($_.Name)"
             $fingerPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_SshHostKeyFingerprint" -Value "$($_.Name)"
-            
+            $sshKeyPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_SshPrivateKey" -Value "$($_.Name)"
+
             $idPreSuf = Format-Name -Type "Connection" -Value "$($_.Name)"
             $displayPreSuf = Format-Name -Type "Connection" -Prefix $Prefix -Suffix "_DisplayName" -Value "$($_.Name)"
 
@@ -98,7 +99,12 @@ Task -Name "Set-Arm.Connections.ManagedApis.SftpWithSsh.Username.Advanced.AsArmO
                 -Type "string" `
                 -Value "$fingerprint" `
                 -Description "The fingerprint that you expect during the initial communication with the Sftp server. ($($_.Name))"
-                
+
+            $armObj = Add-ArmParameter -InputObject $armObj -Name "$sshKeyPreSuf" `
+                -Type "SecureString" `
+                -Value "" `
+                -Description "The SSH private key used to authenticate against the Sftp server. Leave empty when using password authentication. ($($_.Name))"
+
             $armObj = Add-ArmParameter -InputObject $armObj -Name "$displayPreSuf" `
                 -Type "string" `
                 -Value $displayName `
@@ -119,6 +125,7 @@ Task -Name "Set-Arm.Connections.ManagedApis.SftpWithSsh.Username.Advanced.AsArmO
             $apiObj.Properties.ParameterValues.rootFolder = "[parameters('$rootPreSuf')]"
             $apiObj.Properties.ParameterValues.acceptAnySshHostKey = "[parameters('$acceptPreSuf')]"
             $apiObj.Properties.ParameterValues.sshHostKeyFingerprint = "[parameters('$fingerPreSuf')]"
+            $apiObj.Properties.ParameterValues.sshPrivateKey = "[parameters('$sshKeyPreSuf')]"
 
             # Update the api connection object type
             $_.Value.id -match "/managedApis/(.*)"