Merge pull request Azure#4662 from maddieclayton/ObsoleteStrings

Obsolete strings

Author: markcowl

src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/NewAzureApiManagementBackendProxy.cs

@@ -36,12 +36,14 @@ public class NewAzureApiManagementBackendProxy : AzureApiManagementCmdletBase
             ValueFromPipelineByPropertyName = false,
             Mandatory = false,
             HelpMessage = "UserName used to connect to Backend Proxy. This parameter is optional.")]
+        [Obsolete("New-AzureRmApiManagementBackendProxy: The parameter \"UserName\" is being removed in a future release in favor of a new PSCredential parameter (-Credential).")]
         public string UserName { get; set; }
 
         [Parameter(
             ValueFromPipelineByPropertyName = false,
             Mandatory = false,
             HelpMessage = "Password used to connect to Backend Proxy. This parameter is optional.")]
+        [Obsolete("New-AzureRmApiManagementBackendProxy: The parameter \"Password\" is being removed in a future release in favor of a new PSCredential parameter (-Credential).")]
         public string Password { get; set; }
 
         public override void ExecuteApiManagementCmdlet()
@@ -50,8 +52,10 @@ public override void ExecuteApiManagementCmdlet()
                 new PsApiManagementBackendProxy
                 {
                     Url = Url,
+#pragma warning disable 0618
                     UserName = UserName, 
                     Password = Password
+#pragma warning restore 0618
                 });
         }
     }

src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/NewAzureApiManagementUser.cs

@@ -61,6 +61,7 @@ public class NewAzureApiManagementUser : AzureApiManagementCmdletBase
             Mandatory = true,
             HelpMessage = "User password. This parameter is required.")]
         [ValidateNotNullOrEmpty]
+        [Obsolete("New-AzureRmApiManagementUser: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public String Password { get; set; }
 
         [Parameter(
@@ -79,7 +80,9 @@ public override void ExecuteApiManagementCmdlet()
         {
             string userId = UserId ?? Guid.NewGuid().ToString("N");
 
+#pragma warning disable 0618
             var user = Client.UserCreate(Context, userId, FirstName, LastName, Password, Email, State, Note);
+#pragma warning restore 0618
 
             WriteObject(user);
         }

src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/SetAzureApiManagementUser.cs

@@ -58,6 +58,7 @@ public class SetAzureApiManagementUser : AzureApiManagementCmdletBase
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,
             HelpMessage = "User password. This parameter is optional.")]
+        [Obsolete("Set-AzureRmApiManagementUser: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public String Password { get; set; }
 
         [Parameter(
@@ -82,7 +83,9 @@ public class SetAzureApiManagementUser : AzureApiManagementCmdletBase
 
         public override void ExecuteApiManagementCmdlet()
         {
+#pragma warning disable 0618
             Client.UserSet(Context, UserId, FirstName, LastName, Password, Email, State, Note);
+#pragma warning restore 0618
 
             if (PassThru)
             {

src/ResourceManager/ApiManagement/documentation/upcoming-breaking-changes.md

@@ -25,4 +25,42 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes
+# Upcoming Breaking Changes
+
+The following cmdlets were affected this release:
+
+**New-AzureRmApiManagementBackendProxy**
+- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential
+
+```powershell
+
+# Old
+# New-AzureRmApiManagementBackendProxy [other required parameters] -UserName "plain-text string" -Password "plain-text string"
+
+# New
+# New-AzureRmApiManagementBackendProxy [other required parameters] -Credential $PSCredentialVariable
+```
+
+**New-AzureRmApiManagementUser**
+- Parameter "Password" being replaced in favor of a SecureString
+
+```powershell
+
+# Old
+# New-AzureRmApiManagementUser [other required parameters] -Password "plain-text string"
+
+# New
+# New-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable
+```
+
+**Set-AzureRmApiManagementUser**
+- Parameter "Password" being replaced in favor of a SecureString
+
+```powershell
+
+# Old
+# Set-AzureRmApiManagementUser [other required parameters] -Password "plain-text string"
+
+# New
+# Set-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable
+```

src/ResourceManager/AzureBatch/Commands.Batch/Certificates/NewBatchCertificateCommand.cs

@@ -13,6 +13,7 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Commands.Batch.Models;
+using System;
 using System.Management.Automation;
 using Constants = Microsoft.Azure.Commands.Batch.Utils.Constants;
 
@@ -36,14 +37,17 @@ public class NewBatchCertificateCommand : BatchObjectModelCmdletBase
 
         [Parameter]
         [ValidateNotNullOrEmpty]
+        [Obsolete("New-AzureRmBatchCertificate: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public string Password { get; set; }
 
         public override void ExecuteCmdlet()
         {
             NewCertificateParameters parameters = new NewCertificateParameters(this.BatchContext, this.FilePath, this.RawData,
                 this.AdditionalBehaviors)
             {
+#pragma warning disable 0618
                 Password = this.Password
+#pragma warning restore 0618
             };
 
             BatchClient.AddCertificate(parameters);

src/ResourceManager/AzureBatch/Commands.Batch/ComputeNodeUsers/NewBatchComputeNodeUserCommand.cs

@@ -44,6 +44,7 @@ public class NewBatchComputeNodeUserCommand : BatchObjectModelCmdletBase
 
         [Parameter(Mandatory = true, HelpMessage = "The account password.")]
         [ValidateNotNullOrEmpty]
+        [Obsolete("New-AzureRmBatchComputeNodeUser: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public string Password { get; set; }
 
         [Parameter]
@@ -59,7 +60,9 @@ public override void ExecuteCmdlet()
                 this.ComputeNode, this.AdditionalBehaviors)
             {
                 ComputeNodeUserName = this.Name,
+#pragma warning disable 0618
                 Password = this.Password,
+#pragma warning restore 0618
                 ExpiryTime = this.ExpiryTime,
                 IsAdmin = this.IsAdmin.IsPresent
             };

src/ResourceManager/AzureBatch/Commands.Batch/ComputeNodeUsers/SetBatchComputeNodeUserCommand.cs

@@ -39,6 +39,7 @@ public class SetBatchComputeNodeUserCommand : BatchObjectModelCmdletBase
 
         [Parameter(Position = 3, Mandatory = true, HelpMessage = "The account password.")]
         [ValidateNotNullOrEmpty]
+        [Obsolete("Set-AzureRmBatchComputeNodeUser: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public string Password { get; set; }
 
         [Parameter]
@@ -50,7 +51,9 @@ public override void ExecuteCmdlet()
             UpdateComputeNodeUserParameters parameters = new UpdateComputeNodeUserParameters(this.BatchContext,
                 this.PoolId, this.ComputeNodeId, this.Name, this.AdditionalBehaviors)
             {
+#pragma warning disable 0618
                 Password = this.Password,
+#pragma warning restore 0618
                 ExpiryTime = this.ExpiryTime
             };
             this.BatchClient.UpdateComputeNodeUser(parameters);

src/ResourceManager/AzureBatch/documentation/upcoming-breaking-changes.md

@@ -25,4 +25,44 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes
+# Upcoming Breaking Changes   
+
+## Release 5.0.0 - November 2017
+
+The following cmdlets were affected this release:
+
+**New-AzureRmBatchCertificate**
+- Parameter "Password" being replaced in favor of a Secure string
+
+```powershell
+
+# Old
+# New-AzureRmBatchCertificate [other required parameters] -Password "plain-text string"
+
+# New
+# New-AzureRmBatchCertificate [other required parameters] -Password $SecureStringVariable
+```
+
+**New-AzureRmBatchComputeNodeUser**
+- Parameter "Password" being replaced in favor of a Secure string
+
+```powershell
+
+# Old
+# New-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string"
+
+# New
+# New-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
+```
+
+**Set-AzureRmBatchComputeNodeUser**
+- Parameter "Password" being replaced in favor of a Secure string
+
+```powershell
+
+# Old
+# Set-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string"
+
+# New
+# Set-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable
+```

src/ResourceManager/Compute/Commands.Compute/Extension/VMAccess/SetAzureVMAccessExtension.cs

@@ -16,6 +16,7 @@
 using Microsoft.Azure.Commands.Compute.Common;
 using Microsoft.Azure.Commands.Compute.Models;
 using Microsoft.Azure.Management.Compute.Models;
+using System;
 using System.Collections;
 using System.Management.Automation;
 
@@ -35,12 +36,14 @@ public class SetAzureVMAccessExtensionCommand : SetAzureVMExtensionBaseCmdlet
            Mandatory = false,
            ValueFromPipelineByPropertyName = true,
            HelpMessage = "New or Existing User Name")]
+        [Obsolete("Set-AzureRmVMAccessExtension: The parameter \"UserName\" is being removed in a future release in favor of a new PSCredential parameter (-Credential).")]
         public string UserName { get; set; }
 
         [Parameter(
             Mandatory = false,
             ValueFromPipelineByPropertyName = true,
             HelpMessage = "New or Existing User Password")]
+        [Obsolete("Set-AzureRmVMAccessExtension: The parameter \"Password\" is being removed in a future release in favor of a new PSCredential parameter (-Credential).")]
         public string Password { get; set; }
 
         public override void ExecuteCmdlet()

src/ResourceManager/Compute/documentation/upcoming-breaking-changes.md

@@ -25,4 +25,20 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes    
+# Upcoming Breaking Changes   
+
+## Release 5.0.0 - November 2017
+
+The following cmdlets were affected this release:
+
+**Set-AzureRmVMAccessExtension**
+- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential
+
+```powershell
+
+# Old
+# Set-AzureRmVMAccessExtension [other required parameters] -UserName "plain-text string" -Password "plain-text string"
+
+# New
+# Set-AzureRmVMAccessExtension [other required parameters] -Credential $PSCredential
+```

src/ResourceManager/Network/Commands.Network/ApplicationGateway/SslCertificate/AzureApplicationGatewaySslCertificateBase.cs

@@ -38,6 +38,7 @@ public class AzureApplicationGatewaySslCertificateBase : NetworkBaseCmdlet
                Mandatory = true,
                HelpMessage = "Certificate password")]
         [ValidateNotNullOrEmpty]
+        [Obsolete("(Get/Set/New)-AzureRmApplicationGatewaySslCertificate: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public string Password { get; set; }
 
         public PSApplicationGatewaySslCertificate NewObject()
@@ -46,7 +47,9 @@ public PSApplicationGatewaySslCertificate NewObject()
 
             sslCertificate.Name = this.Name;
             sslCertificate.Data = Convert.ToBase64String(File.ReadAllBytes(CertificateFile));
+#pragma warning disable 0618
             sslCertificate.Password = this.Password;
+#pragma warning restore 0618
             sslCertificate.Id =
                 ApplicationGatewayChildResourceHelper.GetResourceNotSetId(
                     this.NetworkClient.NetworkManagementClient.SubscriptionId,

src/ResourceManager/Network/Commands.Network/ApplicationGateway/SslCertificate/SetAzureApplicationGatewaySslCertificateCommand.cs

@@ -40,7 +40,9 @@ public override void ExecuteCmdlet()
                 throw new ArgumentException("Ssl certificate with the specified name does not exist");
             }
 
+#pragma warning disable 0618
             X509Certificate2 cert = new X509Certificate2(CertificateFile, Password, X509KeyStorageFlags.Exportable);
+#pragma warning restore 0618
 
             var newSslCertificate = base.NewObject();
 

src/ResourceManager/Network/documentation/upcoming-breaking-changes.md

@@ -25,4 +25,18 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes
+# Upcoming Breaking Changes
+
+The following cmdlets were affected this release:
+
+**(Get/Set/New)-AzureRmApplicationGatewaySslCertificate**
+- Parameter "Password" being replaced in favor of a SecureString
+
+```powershell
+
+# Old
+# (Get/Set/New)-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string"
+
+# New
+# (Get/Set/New)-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable
+```

src/ResourceManager/Resources/Commands.Resources/ActiveDirectory/NewAzureADAppCredentialCommand.cs

@@ -40,6 +40,7 @@ public class NewAzureADAppCredentialCommand : ActiveDirectoryBaseCmdlet
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationIdWithPassword,
             HelpMessage = "The value for the password credential associated with the application that will be valid for one year by default.")]
         [ValidateNotNullOrEmpty]
+        [Obsolete("New-AzureRmADAppCredential: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public string Password { get; set; }
 
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationObjectIdWithCertValue,
@@ -71,16 +72,19 @@ public override void ExecuteCmdlet()
                     ObjectId = ActiveDirectoryClient.GetObjectIdFromApplicationId(ApplicationId);
                 }
 
-
+#pragma warning disable 0618
                 if (!string.IsNullOrEmpty(Password))
+#pragma warning restore 0618
                 {
                     // Create object for password credential
                     var passwordCredential = new PasswordCredential()
                     {
                         EndDate = EndDate,
                         StartDate = StartDate,
                         KeyId = Guid.NewGuid().ToString(),
+#pragma warning disable 0618
                         Value = Password
+#pragma warning restore 0618
                     };
                     if (ShouldProcess(target: ObjectId, action: string.Format("Adding a new password to application with objectId {0}", ObjectId)))
                     {

src/ResourceManager/Resources/Commands.Resources/ActiveDirectory/NewAzureADApplicationCommand.cs

@@ -99,6 +99,7 @@ public class NewAzureADApplicationCommand : ActiveDirectoryBaseCmdlet
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithPasswordPlain,
             HelpMessage = "The value for the password credential associated with the application that will be valid for one year by default.")]
         [ValidateNotNullOrEmpty]
+        [Obsolete("New-AzureRmADApplication: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public string Password { get; set; }
 
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithKeyPlain,
@@ -146,7 +147,9 @@ public override void ExecuteCmdlet()
                             StartDate = StartDate,
                             EndDate = EndDate,
                             KeyId = Guid.NewGuid(),
+#pragma warning disable 0618
                             Password = Password
+#pragma warning restore 0618
                         }
                     };
                     break;

src/ResourceManager/Resources/Commands.Resources/ActiveDirectory/NewAzureADServicePrincipalCommand.cs

@@ -66,6 +66,7 @@ public class NewAzureADServicePrincipalCommand : ActiveDirectoryBaseCmdlet
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.DisplayNameWithPasswordPlain,
             HelpMessage = "The value for the password credential associated with the application that will be valid for one year by default.")]
         [ValidateNotNullOrEmpty]
+        [Obsolete("New-AzureRmADServicePrincipal: The parameter \"Password\" is being changed from a string to a SecureString in an upcoming breaking change release.")]
         public string Password { get; set; }
 
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithKeyPlain,
@@ -142,7 +143,9 @@ public override void ExecuteCmdlet()
                             StartDate = StartDate,
                             EndDate = EndDate,
                             KeyId = Guid.NewGuid(),
+#pragma warning disable 0618
                             Password = Password
+#pragma warning restore 0618
                         }
                         };
                         break;