Skip to content

Commit cb3a054

Browse files
Rename ResourceIdFilter to Resource
1 parent 2016bff commit cb3a054

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public class ExportAzureResourceGroupCmdlet : ResourceManagerCmdletBase
7979
/// List of resourceIds to filter the results by.
8080
/// </summary>
8181
[Parameter(Mandatory = false, HelpMessage = "A list of resourceIds to filter the results by.")]
82-
public string[] ResourceIdFilter { get; set; }
82+
public string[] Resource { get; set; }
8383

8484
/// <summary>
8585
/// Gets or sets the force parameter.
@@ -190,14 +190,14 @@ private string GetExportOptions()
190190
/// <param name="resourceGroupId"></param>
191191
private string[] GetResourcesFilter(string resourceGroupId)
192192
{
193-
if (this.ResourceIdFilter?.Any() != true)
193+
if (this.Resource?.Any() != true)
194194
{
195195
return new[] { "*" };
196196
}
197197

198198
var resourceIds = new List<ResourceGroupLevelResourceId>();
199199
var subscriptionId = DefaultContext.Subscription.GetId().ToString();
200-
foreach (var filteredResourceId in this.ResourceIdFilter)
200+
foreach (var filteredResourceId in this.Resource)
201201
{
202202
if (!ResourceGroupLevelResourceId.TryParse(filteredResourceId, out var resourceId))
203203
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ function Test-ExportResourceGroupWithFiltering
400400
$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
401401
Assert-NotNull $r2.ResourceId
402402

403-
$exportOutput = Export-AzResourceGroup -ResourceGroupName $rgname -Force -ResourceIdFilter @($r2.ResourceId) -IncludeParameterDefaultValue -IncludeComments
403+
$exportOutput = Export-AzResourceGroup -ResourceGroupName $rgname -Force -Resource @($r2.ResourceId) -IncludeParameterDefaultValue -IncludeComments
404404
Assert-NotNull $exportOutput
405405
Assert-True { $exportOutput.Path.Contains($rgname + ".json") }
406406
}

src/Resources/Resources/ChangeLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* Support for additional Template Export options
2222
- Add `-SkipResourceNameParameterization` parameter to Export-AzResourceGroup
2323
- Add `-SkipAllParameterization` parameter to Export-AzResourceGroup
24-
- Add `-ResourceIdFilter` parameter to Export-AzResourceGroup for exported resource filtering
24+
- Add `-Resource` parameter to Export-AzResourceGroup for exported resource filtering
2525

2626
## Version 1.3.0
2727
* Improve handling of providers for `Get-AzResource` when providing `-ResourceId` or `-ResourceGroupName`, `-Name` and `-ResourceType` parameters

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Captures a resource group as a template and saves it to a file.
1616
```
1717
Export-AzResourceGroup -ResourceGroupName <String> [-Path <String>] [-IncludeParameterDefaultValue]
1818
[-IncludeComments] [-SkipResourceNameParameterization] [-SkipAllParameterization]
19-
[-ResourceIdFilter <String[]>] [-Force] [-ApiVersion <String>] [-Pre]
19+
[-Resource <String[]>] [-Force] [-ApiVersion <String>] [-Pre]
2020
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2121
```
2222

@@ -38,14 +38,14 @@ This command captures the resource group named TestGroup as a template, and save
3838

3939
### Example 2: Export a single resource from a resource group
4040
```
41-
PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -ResourceIdFilter "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"
41+
PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"
4242
```
4343

4444
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.
4545

4646
### Example 3: Export a selection of resources from a resource group
4747
```
48-
PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -ResourceIdFilter @(
48+
PS C:\>Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -Resource @(
4949
"/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVm",
5050
"/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Network/networkInterfaces/TestNic"
5151
)
@@ -176,7 +176,7 @@ Accept pipeline input: True (ByPropertyName)
176176
Accept wildcard characters: False
177177
```
178178
179-
### -ResourceIdFilter
179+
### -Resource
180180
A list of resourceIds to filter the results by.
181181
182182
```yaml

0 commit comments

Comments
 (0)