Skip to content

Commit bad3a2d

Browse files
SandidomsJinLei
andauthored
Remove FilterExpression from Get-AzVMImage documentation (#13952)
* doc update * Update Compute.format.ps1xml * changelog * Update ChangeLog.md * test Co-authored-by: Jin Lei <[email protected]>
1 parent d53002d commit bad3a2d

File tree

5 files changed

+13096
-1040
lines changed

5 files changed

+13096
-1040
lines changed

src/Compute/Compute.Test/ScenarioTests/VirtualMachineTests.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2007,11 +2007,11 @@ function Test-VMImageCmdletOutputFormat
20072007

20082008
Assert-OutputContains " Get-AzVMImagePublisher -Location '$locStr' | ? { `$_.PublisherName -eq `'$publisher`' } | Get-AzVMImageOffer | Get-AzVMImageSku " @('Publisher', 'Offer', 'Skus');
20092009

2010-
Assert-OutputContains " Get-AzVMImagePublisher -Location '$locStr' | ? { `$_.PublisherName -eq `'$publisher`' } | Get-AzVMImageOffer | Get-AzVMImageSku | Get-AzVMImage " @('Version', 'FilterExpression', 'Skus');
2010+
Assert-OutputContains " Get-AzVMImagePublisher -Location '$locStr' | ? { `$_.PublisherName -eq `'$publisher`' } | Get-AzVMImageOffer | Get-AzVMImageSku | Get-AzVMImage " @('Version', 'Skus');
20112011

2012-
Assert-OutputContains " Get-AzVMImage -Location '$locStr' -PublisherName $publisher -Offer $offer -Skus $sku -Version $ver " @('Id', 'Location', 'PublisherName', 'Offer', 'Sku', 'Version', 'FilterExpression', 'Name', 'DataDiskImages', 'OSDiskImage', 'PurchasePlan');
2012+
Assert-OutputContains " Get-AzVMImage -Location '$locStr' -PublisherName $publisher -Offer $offer -Skus $sku -Version $ver " @('Id', 'Location', 'PublisherName', 'Offer', 'Sku', 'Version', 'Name', 'DataDiskImages', 'OSDiskImage', 'PurchasePlan');
20132013

2014-
Assert-OutputContains " Get-AzVMImage -Location '$locStr' -PublisherName $publisher -Offer $offer -Skus $sku -Version $ver " @('Id', 'Location', 'PublisherName', 'Offer', 'Sku', 'Version', 'FilterExpression', 'Name', 'DataDiskImages', 'OSDiskImage', 'PurchasePlan');
2014+
Assert-OutputContains " Get-AzVMImage -Location '$locStr' -PublisherName $publisher -Offer $offer -Skus $sku -Version $ver " @('Id', 'Location', 'PublisherName', 'Offer', 'Sku', 'Version', 'Name', 'DataDiskImages', 'OSDiskImage', 'PurchasePlan');
20152015
}
20162016

20172017
# Test Get VM Size from All Locations

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineTests/TestVMImageCmdletOutputFormat.json

Lines changed: 13072 additions & 1012 deletions
Large diffs are not rendered by default.

src/Compute/Compute/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
2121
-->
2222
## Upcoming Release
23+
* Removed FilterExpression parameter from `Get-AzVMImage` cmdlet documentation.
2324
* Added deprecation message to the ContainerService cmdlets:
2425
- `Add-AzureRmContainerServiceAgentPoolProfileCommand`
2526
- `Get-AzContainerService`

src/Compute/Compute/Compute.format.ps1xml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,17 +183,13 @@
183183
<TableColumnHeader/>
184184
<TableColumnHeader/>
185185
<TableColumnHeader/>
186-
<TableColumnHeader/>
187186
</TableHeaders>
188187
<TableRowEntries>
189188
<TableRowEntry>
190189
<TableColumnItems>
191190
<TableColumnItem>
192191
<PropertyName>Version</PropertyName>
193192
</TableColumnItem>
194-
<TableColumnItem>
195-
<PropertyName>FilterExpression</PropertyName>
196-
</TableColumnItem>
197193
<TableColumnItem>
198194
<PropertyName>Skus</PropertyName>
199195
</TableColumnItem>

src/Compute/Compute/help/Get-AzVMImage.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,18 @@ The **Get-AzVMImage** cmdlet gets all the versions of a VMImage.
3434
```
3535
PS C:\> Get-AzVMImage -Location "Central US" -PublisherName "MicrosoftWindowsServer" -Offer "windowsserver" -Skus "2012-R2-Datacenter"
3636
37-
Version FilterExpression Skus Offer PublisherName Location Id
38-
------- ---------------- ---- ----- ------------- -------- --
39-
4.127.20180315 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
40-
4.127.20180510 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
41-
4.127.20180815 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
42-
4.127.20180912 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
43-
4.127.20181010 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
44-
4.127.20181125 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
45-
4.127.20190104 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
46-
4.127.20190115 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
47-
4.127.20190204 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
48-
4.127.20190218 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
37+
Version Skus Offer PublisherName Location Id
38+
------- ---- ----- ------------- -------- --
39+
4.127.20180315 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
40+
4.127.20180510 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
41+
4.127.20180815 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
42+
4.127.20180912 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
43+
4.127.20181010 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
44+
4.127.20181125 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
45+
4.127.20190104 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
46+
4.127.20190115 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
47+
4.127.20190204 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
48+
4.127.20190218 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
4949
```
5050

5151
This command gets all the versions of VMImage that match the specified values.
@@ -62,7 +62,6 @@ PublisherName : MicrosoftWindowsServer
6262
Offer : windowsserver
6363
Skus : 2012-R2-Datacenter
6464
Version : 4.127.20180315
65-
FilterExpression :
6665
Name : 4.127.20180315
6766
OSDiskImage : {
6867
"operatingSystem": "Windows"
@@ -77,14 +76,14 @@ This command gets a specific version of VMImage that matches the specified value
7776
```
7877
PS C:\> Get-AzVMImage -Location "Central US" -PublisherName "MicrosoftWindowsServer" -Offer "windowsserver" -Skus "2012-R2-Datacenter" -Version 4.127.2018*
7978
80-
Version FilterExpression Skus Offer PublisherName Location Id
81-
------- ---------------- ---- ----- ------------- -------- --
82-
4.127.20180315 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
83-
4.127.20180510 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
84-
4.127.20180815 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
85-
4.127.20180912 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
86-
4.127.20181010 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
87-
4.127.20181125 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
79+
Version Skus Offer PublisherName Location Id
80+
------- ---- ----- ------------- -------- --
81+
4.127.20180315 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
82+
4.127.20180510 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
83+
4.127.20180815 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
84+
4.127.20180912 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
85+
4.127.20181010 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
86+
4.127.20181125 2012-R2-Datacenter windowsserver MicrosoftWindowsServer centralus /Subscriptions/9e2...
8887
```
8988

9089
This command gets all the versions of VMImage that match the specified values with filtering over version.

0 commit comments

Comments
 (0)