Skip to content

Commit 85e5f8f

Browse files
committed
[GuestConfiguration] help doc fixes before publishing to testGallery
1 parent 5bcd2fb commit 85e5f8f

File tree

2 files changed

+16
-19
lines changed

2 files changed

+16
-19
lines changed

src/GuestConfiguration/GuestConfiguration/help/Get-AzVMGuestPolicyStatus.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ Get-AzVMGuestPolicyStatus [-ResourceGroupName] <String> [-VMName] <String> [-Ini
3030
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3131
```
3232

33-
### ReportIdScope
33+
### IdScope
3434
```
35-
Get-AzVMGuestPolicyStatus [-ReportId] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
35+
Get-AzVMGuestPolicyStatus [-Id] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3636
```
3737

3838
## DESCRIPTION
@@ -115,13 +115,13 @@ Accept pipeline input: False
115115
Accept wildcard characters: False
116116
```
117117
118-
### -ReportId
119-
Report Id of a Guest Configuration policy report.
120-
A policy whose definition type is Initiative and category is Guest Configuration must be assigned to a scope to get reports.
118+
### -Id
119+
Id of a Guest Configuration policy status.
120+
A policy where definition type is Initiative and category is Guest Configuration must be assigned to a scope to get statuses.
121121
122122
```yaml
123123
Type: System.String
124-
Parameter Sets: ReportIdScope
124+
Parameter Sets: IdScope
125125
Aliases:
126126

127127
Required: True
@@ -172,9 +172,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
172172
173173
## OUTPUTS
174174
175-
### System.Collections.Generic.IList`1[[Microsoft.Azure.Management.GuestConfiguration.Models.GuestConfigurationAssignment, Microsoft.Azure.Management.GuestConfiguration, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
176-
177-
### System.Collections.Generic.IList`1[[Microsoft.Azure.Management.GuestConfiguration.Models.GuestConfigurationAssignmentReport, Microsoft.Azure.Management.GuestConfiguration, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
175+
### [Microsoft.Azure.Management.GuestConfiguration.Models.PolicyStatusDetailed, Microsoft.Azure.Management.GuestConfiguration, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]
178176
179177
## NOTES
180178

src/GuestConfiguration/GuestConfiguration/help/Get-AzVMGuestPolicyStatusHistory.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ An initiative is a policy of definition type "Initiative".
1515

1616
### VmScope (Default)
1717
```
18-
Get-AzVMGuestPolicyStatusHistory [-ResourceGroupName] <String> [-VMName] <String> [-ShowOnlyChange]
19-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
18+
Get-AzVMGuestPolicyStatusHistory [-ResourceGroupName] <String> [-VMName] <String>
19+
[-ShowOnlyChange] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2020
```
2121

2222
### InitiativeIdScope
@@ -40,29 +40,29 @@ Use Get-AzVMGuestPolicyStatus cmdlet to get details of a single compliance statu
4040

4141
### Example 1
4242
```
43-
PS C:\> Get-AzVMGuestPolicyStatusHistory -ResourceGroupName "MyResourceGroupName" -VMName "MyVMName" -InitiativeId "/providers/Microsoft.Authorization/policySetDefinitions/3fa7cbf5-c0a4-4a59-85a5-cca4d996d5af" -ShowOnlyChanges
43+
PS C:\> Get-AzVMGuestPolicyStatusHistory -ResourceGroupName "MyResourceGroupName" -VMName "MyVMName" -InitiativeId "/providers/Microsoft.Authorization/policySetDefinitions/3fa7cbf5-c0a4-4a59-85a5-cca4d996d5af" -ShowOnlyChange
4444
```
4545

4646
Gets compliance status history by initiative Id.
47-
ShowOnlyChanges switch shows only historical status changes.
47+
ShowOnlyChange switch shows only historical status changes.
4848
Skips statuses that have not changed between two compliance checks.
4949

5050
### Example 2
5151
```
52-
PS C:\> Get-AzVMGuestPolicyStatusHistory -ResourceGroupName "MyResourceGroupName" -VMName "MyVMName" -InitiativeName "b5a822e0-ba98-4e54-9278-5d9833aa9b17" -ShowOnlyChanges
52+
PS C:\> Get-AzVMGuestPolicyStatusHistory -ResourceGroupName "MyResourceGroupName" -VMName "MyVMName" -InitiativeName "b5a822e0-ba98-4e54-9278-5d9833aa9b17" -ShowOnlyChange
5353
```
5454

5555
Gets compliance status history by initiative name.
56-
ShowOnlyChanges switch shows only historical status changes.
56+
ShowOnlyChange switch shows only historical status changes.
5757
Skips statuses that have not changed between two compliance checks.
5858

5959
### Example 3
6060
```
61-
PS C:\> Get-AzVMGuestPolicyStatusHistory -ResourceGroupName "MyResourceGroupName" -VMName "MyVMName" -ShowOnlyChanges
61+
PS C:\> Get-AzVMGuestPolicyStatusHistory -ResourceGroupName "MyResourceGroupName" -VMName "MyVMName" -ShowOnlyChange
6262
```
6363

6464
Gets compliance status history for all guest configuration policies assigned to the VM.
65-
ShowOnlyChanges switch shows only historical status changes.
65+
ShowOnlyChange switch shows only historical status changes.
6666
Skips statuses that have not changed between two compliance checks.
6767

6868
### Example 4
@@ -195,8 +195,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
195195
### System.Management.Automation.SwitchParameter
196196
## OUTPUTS
197197
198-
### System.Collections.Generic.IList`1[[Microsoft.Azure.Management.GuestConfiguration.Models.GuestConfigurationAssignment, Microsoft.Azure.Management.GuestConfiguration, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
199-
### System.Collections.Generic.IList`1[[Microsoft.Azure.Management.GuestConfiguration.Models.GuestConfigurationAssignmentReport, Microsoft.Azure.Management.GuestConfiguration, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]
198+
### [Microsoft.Azure.Management.GuestConfiguration.Models.PolicyStatus, Microsoft.Azure.Management.GuestConfiguration, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]
200199
## NOTES
201200
202201
## RELATED LINKS

0 commit comments

Comments
 (0)