Rename 'FilteredResourceIds' param to 'ResourceIdFilter'

Author: anthony-c-martin

src/Resources/ResourceManager/Implementation/ResourceGroups/ExportAzureResourceGroupCmdlet.cs

@@ -79,7 +79,7 @@ public class ExportAzureResourceGroupCmdlet : ResourceManagerCmdletBase
         /// List of resourceIds to filter the results by.
         /// </summary>
         [Parameter(Mandatory = false, HelpMessage = "A list of resourceIds to filter the results by.")]
-        public string[] FilteredResourceIds { get; set; }
+        public string[] ResourceIdFilter { get; set; }
 
         /// <summary>
         /// Gets or sets the force parameter.
@@ -190,14 +190,14 @@ private string GetExportOptions()
         /// <param name="resourceGroupId"></param>
         private string[] GetResourcesFilter(string resourceGroupId)
         {
-            if (this.FilteredResourceIds?.Any() != true)
+            if (this.ResourceIdFilter?.Any() != true)
             {
                 return new[] { "*" };
             }
 
             var resourceIds = new List<ResourceGroupLevelResourceId>();
             var subscriptionId = DefaultContext.Subscription.GetId().ToString();
-            foreach (var filteredResourceId in this.FilteredResourceIds)
+            foreach (var filteredResourceId in this.ResourceIdFilter)
             {
                 if (!ResourceGroupLevelResourceId.TryParse(filteredResourceId, out var resourceId))
                 {

src/Resources/Resources.Test/ScenarioTests/ResourceGroupTests.ps1

@@ -400,7 +400,7 @@ function Test-ExportResourceGroupWithFiltering
         $r2 = New-AzResource -Name $rname2 -Location "centralus" -Tags @{ testtag = "testval"} -ResourceGroupName $rgname -ResourceType $resourceType -PropertyObject @{"administratorLogin" = "adminuser"; "administratorLoginPassword" = "P@ssword1"} -SkuObject @{ Name = "A0" } -ApiVersion $apiversion -Force
         Assert-NotNull $r2.ResourceId
 
-        $exportOutput = Export-AzResourceGroup -ResourceGroupName $rgname -Force -FilteredResourceIds @($r2.ResourceId) -IncludeParameterDefaultValue -IncludeComments
+        $exportOutput = Export-AzResourceGroup -ResourceGroupName $rgname -Force -ResourceIdFilter @($r2.ResourceId) -IncludeParameterDefaultValue -IncludeComments
         Assert-NotNull $exportOutput
         Assert-True { $exportOutput.Path.Contains($rgname + ".json") }
     }

src/Resources/Resources/ChangeLog.md

@@ -21,7 +21,7 @@
 * Support for additional Template Export options
     - Add `-SkipResourceNameParameterization` parameter to Export-AzResourceGroup
     - Add `-SkipAllParameterization` parameter to Export-AzResourceGroup
-    - Add `-FilteredResourceIds` parameter to Export-AzResourceGroup for exported resource filtering
+    - Add `-ResourceIdFilter` parameter to Export-AzResourceGroup for exported resource filtering
 
 ## Version 1.3.0
 * Improve handling of providers for `Get-AzResource` when providing `-ResourceId` or `-ResourceGroupName`, `-Name` and `-ResourceType` parameters

src/Resources/Resources/help/Export-AzResourceGroup.md

@@ -16,7 +16,7 @@ Captures a resource group as a template and saves it to a file.
 ```
 Export-AzResourceGroup -ResourceGroupName <String> [-Path <String>] [-IncludeParameterDefaultValue]
  [-IncludeComments] [-SkipResourceNameParameterization] [-SkipAllParameterization]
- [-FilteredResourceIds <String[]>] [-Force] [-ApiVersion <String>] [-Pre]
+ [-ResourceIdFilter <String[]>] [-Force] [-ApiVersion <String>] [-Pre]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -38,14 +38,14 @@ This command captures the resource group named TestGroup as a template, and save
 
 ### Example 2: Export a single resource from a resource group
 ```
-PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -FilteredResourceIds "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"
+PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -ResourceIdFilter "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"
 ```
 
 This command captures the Virtual Machine resource named "TestVirtualMachine" from the "TestGroup" resource group as a template, and saves it to a JSON file in the current directory.
 
 ### Example 3: Export a selection of resources from a resource group
 ```
-PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -FilteredResourceIds @(
+PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -ResourceIdFilter @(
   "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVm",
   "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Network/networkInterfaces/TestNic"
 )
@@ -86,21 +86,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -FilteredResourceIds
-A list of resourceIds to filter the results by.
-
-```yaml
-Type: System.String[]
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -Force
 Forces the command to run without asking for user confirmation.
 
@@ -191,6 +176,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -ResourceIdFilter
+A list of resourceIds to filter the results by.
+
+```yaml
+Type: System.String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -SkipAllParameterization
 Skip all parameterization.