update the output type of Get-AzWebAppPublishingProfile from String t…

…o SecureString
Azure · Dec 18, 2024 · 8a7cef5 · 8a7cef5
1 parent 7236500
commit 8a7cef5
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 9 deletions.
diff --git a/src/Websites/Websites.Test/ScenarioTests/WebAppTests.ps1 b/src/Websites/Websites.Test/ScenarioTests/WebAppTests.ps1
@@ -1138,7 +1138,7 @@ function Test-WebAppPublishingProfile
 		Assert-AreEqual $serverFarm.Id $webapp.ServerFarmId
 
 		# Get web app publishing profile
-		[xml]$profile = Get-AzWebAppPublishingProfile -ResourceGroupName $rgname -Name $appName -OutputFile $profileFileName
+		[xml]$profile = Get-AzWebAppPublishingProfile -ResourceGroupName $rgname -Name $appName -OutputFile $profileFileName | ConvertFrom-SecureString -AsPlainText
 		$msDeployProfile = $profile.publishData.publishProfile | ? { $_.publishMethod -eq 'MSDeploy' } | Select -First 1
 		$pass = $msDeployProfile.userPWD
 
@@ -1152,14 +1152,14 @@ function Test-WebAppPublishingProfile
 		Assert-False { $pass -eq $newPass }
 
 		# Get web app publishing profile
-		[xml]$profile = $webapp | Get-AzWebAppPublishingProfile -OutputFile $profileFileName -Format FileZilla3
+		[xml]$profile = $webapp | Get-AzWebAppPublishingProfile -OutputFile $profileFileName -Format FileZilla3 | ConvertFrom-SecureString -AsPlainText
 		$fileZillaProfile = $profile.FileZilla3.Servers.Server
 
 		# Assert
 		Assert-True { $fileZillaProfile.Name -eq $appName }
 
 		# Get web app publishing profile without OutputFile
-		[xml]$profile = Get-AzWebAppPublishingProfile -ResourceGroupName $rgname -Name $appName
+		[xml]$profile = Get-AzWebAppPublishingProfile -ResourceGroupName $rgname -Name $appName | ConvertFrom-SecureString -AsPlainText
 
 		# Assert
 		Assert-NotNull $profile
@@ -1232,7 +1232,6 @@ function Test-PublishAzureWebAppFromWar
         $javaContainerVersion="8.5"
         $PropertiesObject = @{javaVersion = $javaVersion;javaContainer = $javaContainer;javaContainerVersion = $javaContainerVersion}
         New-AzResource -PropertyObject $PropertiesObject -ResourceGroupName $rgname -ResourceType Microsoft.Web/sites/config -ResourceName "$appName/web" -ApiVersion 2018-02-01 -Force
-
 		$warPath = Join-Path $ResourcesPath "HelloJava.war"
 		$publishedApp = Publish-AzWebApp -ResourceGroupName $rgname -Name $appName -ArchivePath $warPath -Force
 

diff --git a/src/Websites/Websites/Cmdlets/WebApps/GetAzureWebAppPublishingProfile.cs b/src/Websites/Websites/Cmdlets/WebApps/GetAzureWebAppPublishingProfile.cs
@@ -15,14 +15,15 @@
 
 
 using System.Management.Automation;
+using System.Security;
 
 namespace Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps
 {
     /// <summary>
     /// this commandlet will get the publishing creds of the given Azure Web app using ARM APIs
     /// </summary>
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "WebAppPublishingProfile")]
-    [OutputType(typeof(string))]
+    [OutputType(typeof(SecureString))]
     public class GetAzureWebAppPublishingProfileCmdlet : WebAppBaseCmdlet
     {
         private const string DefaultFormat = "WebDeploy";
@@ -46,7 +47,8 @@ public GetAzureWebAppPublishingProfileCmdlet()
         public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();
-            WriteObject(WebsitesClient.GetWebAppPublishingProfile(ResourceGroupName, Name, null, OutputFile, Format, IncludeDisasterRecoveryEndpoints));
+            string profile = WebsitesClient.GetWebAppPublishingProfile(ResourceGroupName, Name, null, OutputFile, Format, IncludeDisasterRecoveryEndpoints);
+            WriteObject(profile.ToSecureString());
         }
 
     }

diff --git a/src/Websites/Websites/Cmdlets/WebApps/Utils.cs b/src/Websites/Websites/Cmdlets/WebApps/Utils.cs
@@ -0,0 +1,19 @@
+namespace Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps
+{
+    public static class Utils
+    {
+        public static System.Security.SecureString ToSecureString(this string input)
+        {
+            if (string.IsNullOrEmpty(input))
+                return null;
+
+            System.Security.SecureString secureString = new System.Security.SecureString();
+            foreach (char c in input)
+            {
+                secureString.AppendChar(c);
+            }
+            secureString.MakeReadOnly();
+            return secureString;
+        }
+    }
+}
diff --git a/src/Websites/Websites/help/Get-AzWebAppPublishingProfile.md b/src/Websites/Websites/help/Get-AzWebAppPublishingProfile.md
@@ -17,13 +17,13 @@ Gets an Azure Web App publishing profile.
 ```
 Get-AzWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-IncludeDisasterRecoveryEndpoints]
  [-ResourceGroupName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
- [<CommonParameters>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ### S2
 ```
 Get-AzWebAppPublishingProfile [[-OutputFile] <String>] [[-Format] <String>] [-IncludeDisasterRecoveryEndpoints]
- [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>]
+ [-WebApp] <PSSite> [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>]
  [<CommonParameters>]
 ```
 
@@ -118,6 +118,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: System.Management.Automation.ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ResourceGroupName
 Resource Group Name
 
@@ -159,7 +174,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### System.String
+### System.Security.SecureString
 
 ## NOTES