Merge pull request Azure#6097 from AMoghrabi/fix-get-traffic-manager-profile

Fix Get-AzureRmTrafficManagerProfile when calling with -Name Parameter Only (Issue Azure#2342)

Author: Maddie Clayton

src/ResourceManager/TrafficManager/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Update the parameters for `Get-AzureRmTrafficManagerProfile` so that -ResourceGroupName parameter is required when using -Name parameter.
 
 ## Version 4.0.4
 * Set minimum dependency of module to PowerShell 5.0

src/ResourceManager/TrafficManager/Commands.TrafficManager2/Profile/GetAzureTrafficManagerProfile.cs

@@ -23,22 +23,37 @@ namespace Microsoft.Azure.Commands.TrafficManager
     [Cmdlet(VerbsCommon.Get, "AzureRmTrafficManagerProfile"), OutputType(typeof(TrafficManagerProfile))]
     public class GetAzureTrafficManagerProfile : TrafficManagerBaseCmdlet
     {
-        [Parameter(Mandatory = false, HelpMessage = "The name of the profile.")]
-        [ValidateNotNullOrEmpty]
-        public string Name { get; set; }
+        protected const string ResourceGroupParameterSet = "ResourceGroupParameterSet";
+        protected const string AccountNameParameterSet = "AccountNameParameterSet";
 
-        [Parameter(Mandatory = false, HelpMessage = "The resource group to which the profile belongs.")]
+        [Parameter(
+            Position = 0,
+            Mandatory = false,
+            ParameterSetName = ResourceGroupParameterSet,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The resource group to which the profile belongs.")]
+        [Parameter(
+            Position = 0,
+            Mandatory = true,
+            ParameterSetName = AccountNameParameterSet,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The resource group to which the profile belongs.")]
         [ResourceGroupCompleter]
         [ValidateNotNullOrEmpty]
         public string ResourceGroupName { get; set; }
 
+        [Parameter(
+            Position = 1,
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = true,
+            ParameterSetName = AccountNameParameterSet,
+            HelpMessage = "The name of the profile.")]
+        [ValidateNotNullOrEmpty]
+        public string Name { get; set; }
+
         public override void ExecuteCmdlet()
         {
-            if (this.ResourceGroupName == null && this.Name != null)
-            {
-                // Throw an error
-            }
-            else if (this.ResourceGroupName != null && this.Name != null)
+            if (this.ResourceGroupName != null && this.Name != null)
             {
                 TrafficManagerProfile profile = this.TrafficManagerClient.GetTrafficManagerProfile(this.ResourceGroupName, this.Name);
 

src/ResourceManager/TrafficManager/Commands.TrafficManager2/help/Get-AzureRmTrafficManagerProfile.md

@@ -1,6 +1,6 @@
----
+---
 external help file: Microsoft.Azure.Commands.TrafficManager.dll-Help.xml
-Module Name: AzureRM
+Module Name: AzureRM.TrafficManager
 ms.assetid: 5032D487-3849-4C80-BD14-5B735FC39285
 online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/get-azurermtrafficmanagerprofile
 schema: 2.0.0
@@ -13,8 +13,15 @@ Gets a Traffic Manager profile.
 
 ## SYNTAX
 
+### ResourceGroupParameterSet
+```
+Get-AzureRmTrafficManagerProfile [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>]
+ [<CommonParameters>]
 ```
-Get-AzureRmTrafficManagerProfile [-Name <String>] [-ResourceGroupName <String>]
+
+### AccountNameParameterSet
+```
+Get-AzureRmTrafficManagerProfile [-ResourceGroupName] <String> [-Name] <String>
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
@@ -55,13 +62,13 @@ Specifies the name of the Traffic Manager profile that this cmdlet gets.
 
 ```yaml
 Type: String
-Parameter Sets: (All)
-Aliases: 
+Parameter Sets: AccountNameParameterSet
+Aliases:
 
-Required: False
-Position: Named
+Required: True
+Position: 1
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
@@ -70,13 +77,25 @@ Specifies the name of a resource group that contains the Traffic Manager profile
 
 ```yaml
 Type: String
-Parameter Sets: (All)
-Aliases: 
+Parameter Sets: ResourceGroupParameterSet
+Aliases:
 
 Required: False
-Position: Named
+Position: 0
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+```yaml
+Type: String
+Parameter Sets: AccountNameParameterSet
+Aliases:
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 

tools/StaticAnalysis/Exceptions/BreakingChangeIssues.csv

@@ -1603,4 +1603,5 @@
 "Microsoft.Azure.Commands.Network.dll","Microsoft.Azure.Commands.Network.NewAzureVirtualNetworkCommand","New-AzureRmVirtualNetwork","0","3010","The property 'EnableDDoSProtection' of type 'Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork' has been removed.","Add the property 'EnableDDoSProtection' back to type 'Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork'."
 "Microsoft.Azure.Commands.Network.dll","Microsoft.Azure.Commands.Network.NewAzureVirtualNetworkCommand","New-AzureRmVirtualNetwork","0","3010","The property 'EnableDDoSProtectionText' of type 'Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork' has been removed.","Add the property 'EnableDDoSProtectionText' back to type 'Microsoft.Azure.Commands.Network.Models.PSVirtualNetwork'."
 "Microsoft.Azure.Commands.Network.dll","Microsoft.Azure.Commands.Network.NewAzureVirtualNetworkCommand","New-AzureRmVirtualNetwork","0","2000","The cmdlet 'New-AzureRmVirtualNetwork' no longer supports the parameter 'EnableDDoSProtection' and no alias was found for the original parameter name.","Add the parameter 'EnableDDoSProtection' back to the cmdlet 'New-AzureRmVirtualNetwork', or add an alias to the original parameter name."
-"Microsoft.Azure.Commands.Network.dll","Microsoft.Azure.Commands.Network.NewAzureVirtualNetworkCommand","New-AzureRmVirtualNetwork","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzureRmVirtualNetwork' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzureRmVirtualNetwork'."
+"Microsoft.Azure.Commands.Network.dll","Microsoft.Azure.Commands.Network.NewAzureVirtualNetworkCommand","New-AzureRmVirtualNetwork","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzureRmVirtualNetwork' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzureRmVirtualNetwork'."
+"Microsoft.Azure.Commands.TrafficManager.dll","Microsoft.Azure.Commands.TrafficManager.GetAzureTrafficManagerProfile","Get-AzureRmTrafficManagerProfile","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Get-AzureRmTrafficManagerProfile' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Get-AzureRmTrafficManagerProfile'."