Skip to content

Commit 53fe55c

Browse files
pilorpilor
committed
Add remediation cmdlet help documentation
1 parent 4a9fec6 commit 53fe55c

12 files changed

+1180
-25
lines changed

‎src/ResourceManager/PolicyInsights/Commands.PolicyInsights/Az.PolicyInsights.psd1

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ FunctionsToExport = @()
7575
CmdletsToExport = 'Get-AzPolicyEvent',
7676
'Get-AzPolicyState',
7777
'Get-AzPolicyStateSummary',
78-
'Get-AzureRmPolicyRemediation',
79-
'Remove-AzureRmPolicyRemediation',
80-
'New-AzureRmPolicyRemediation',
81-
'Stop-AzureRmPolicyRemediation',
82-
'Get-AzureRmPolicyRemediationDeployment'
78+
'Get-AzPolicyRemediation',
79+
'Remove-AzPolicyRemediation',
80+
'New-AzPolicyRemediation',
81+
'Stop-AzPolicyRemediation',
82+
'Get-AzPolicyRemediationDeployment'
8383

8484
# Variables to export from this module
8585
# VariablesToExport = @()

‎src/ResourceManager/PolicyInsights/Commands.PolicyInsights/Cmdlets/Remediation/GetAzureRmPolicyRemediation.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ public class GetAzureRmPolicyRemediation : RemediationCmdletBase
3434
[ValidateNotNullOrEmpty]
3535
public string Name { get; set; }
3636

37-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
37+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Scope)]
3838
[Parameter(ParameterSetName = ParameterSetNames.GenericScope, Mandatory = true, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Scope)]
3939
[ValidateNotNullOrEmpty]
4040
public string Scope { get; set; }
4141

42-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
42+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ManagementGroupName)]
4343
[Parameter(ParameterSetName = ParameterSetNames.ManagementGroupScope, Mandatory = true, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ManagementGroupName)]
4444
[ValidateNotNullOrEmpty]
4545
public string ManagementGroupName { get; set; }
4646

47-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
47+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
4848
[Parameter(ParameterSetName = ParameterSetNames.ResourceGroupScope, Mandatory = true, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
4949
[ResourceGroupCompleter]
5050
[ValidateNotNullOrEmpty]
@@ -61,10 +61,10 @@ public class GetAzureRmPolicyRemediation : RemediationCmdletBase
6161
[Parameter(ParameterSetName = ParameterSetNames.GenericScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Top)]
6262
public int Top { get; set; }
6363

64-
[Parameter(ParameterSetName = ParameterSetNames.ManagementGroupScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Top)]
65-
[Parameter(ParameterSetName = ParameterSetNames.SubscriptionScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Top)]
66-
[Parameter(ParameterSetName = ParameterSetNames.ResourceGroupScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Top)]
67-
[Parameter(ParameterSetName = ParameterSetNames.GenericScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Top)]
64+
[Parameter(ParameterSetName = ParameterSetNames.ManagementGroupScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Filter)]
65+
[Parameter(ParameterSetName = ParameterSetNames.SubscriptionScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Filter)]
66+
[Parameter(ParameterSetName = ParameterSetNames.ResourceGroupScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Filter)]
67+
[Parameter(ParameterSetName = ParameterSetNames.GenericScope, Mandatory = false, HelpMessage = ParameterHelpMessages.Filter)]
6868
[ValidateNotNullOrEmpty]
6969
public string Filter { get; set; }
7070

‎src/ResourceManager/PolicyInsights/Commands.PolicyInsights/Cmdlets/Remediation/GetAzureRmPolicyRemediationDeployment.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ public class GetAzureRmPolicyRemediationDeployment : RemediationCmdletBase
3434
[ValidateNotNullOrEmpty]
3535
public string Name { get; set; }
3636

37-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
37+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Scope)]
3838
[ValidateNotNullOrEmpty]
3939
public string Scope { get; set; }
4040

41-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
41+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ManagementGroupName)]
4242
[ValidateNotNullOrEmpty]
4343
public string ManagementGroupName { get; set; }
4444

45-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
45+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
4646
[ResourceGroupCompleter]
4747
[ValidateNotNullOrEmpty]
4848
public string ResourceGroupName { get; set; }

‎src/ResourceManager/PolicyInsights/Commands.PolicyInsights/Cmdlets/Remediation/NewAzureRmPolicyRemediation.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ public class NewAzureRmPolicyRemediation : RemediationCmdletBase
3333
[ValidateNotNullOrEmpty]
3434
public string Name { get; set; }
3535

36-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
36+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Scope)]
3737
[ValidateNotNullOrEmpty]
3838
public string Scope { get; set; }
3939

40-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
40+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ManagementGroupName)]
4141
[ValidateNotNullOrEmpty]
4242
public string ManagementGroupName { get; set; }
4343

44-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
44+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
4545
[ResourceGroupCompleter]
4646
[ValidateNotNullOrEmpty]
4747
public string ResourceGroupName { get; set; }

‎src/ResourceManager/PolicyInsights/Commands.PolicyInsights/Cmdlets/Remediation/RemoveAzureRmPolicyRemediation.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ public class RemoveAzureRmPolicyRemediation : RemediationCmdletBase
3232
[ValidateNotNullOrEmpty]
3333
public string Name { get; set; }
3434

35-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
35+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Scope)]
3636
[ValidateNotNullOrEmpty]
3737
public string Scope { get; set; }
3838

39-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
39+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ManagementGroupName)]
4040
[ValidateNotNullOrEmpty]
4141
public string ManagementGroupName { get; set; }
4242

43-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
43+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
4444
[ResourceGroupCompleter]
4545
[ValidateNotNullOrEmpty]
4646
public string ResourceGroupName { get; set; }

‎src/ResourceManager/PolicyInsights/Commands.PolicyInsights/Cmdlets/Remediation/StopAzureRmPolicyRemediation.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ public class StopAzureRmPolicyRemediation : RemediationCmdletBase
3232
[ValidateNotNullOrEmpty]
3333
public string Name { get; set; }
3434

35-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
35+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Scope)]
3636
[ValidateNotNullOrEmpty]
3737
public string Scope { get; set; }
3838

39-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
39+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ManagementGroupName)]
4040
[ValidateNotNullOrEmpty]
4141
public string ManagementGroupName { get; set; }
4242

43-
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.Name)]
43+
[Parameter(ParameterSetName = ParameterSetNames.ByName, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = ParameterHelpMessages.ResourceGroupName)]
4444
[ResourceGroupCompleter]
4545
[ValidateNotNullOrEmpty]
4646
public string ResourceGroupName { get; set; }

‎src/ResourceManager/PolicyInsights/Commands.PolicyInsights/help/AzureRM.PolicyInsights.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Module Name: AzureRM.PolicyInsights
33
Module Guid: B1876B47-3652-4265-9AD5-782EC3E98319
44
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/azurerm.policyinsights
5-
Help Version: 1.0.0.0
5+
Help Version: 1.1.0.0
66
Locale: en-US
77
---
88

@@ -14,9 +14,24 @@ This topic displays help for the Azure Policy Insights cmdlets.
1414
### [Get-AzureRmPolicyEvent](Get-AzureRmPolicyEvent.md)
1515
Gets policy evaluation events generated as resources are created or updated.
1616

17+
### [Get-AzureRmPolicyRemediation](Get-AzureRmPolicyRemediation.md)
18+
Gets policy remediations.
19+
20+
### [Get-AzureRmPolicyRemediationDeployment](Get-AzureRmPolicyRemediationDeployment.md)
21+
Gets the status of the deployments executed by a remediation.
22+
1723
### [Get-AzureRmPolicyState](Get-AzureRmPolicyState.md)
1824
Gets policy compliance states for resources.
1925

2026
### [Get-AzureRmPolicyStateSummary](Get-AzureRmPolicyStateSummary.md)
2127
Gets latest policy compliance states summary for resources.
2228

29+
### [New-AzureRmPolicyRemediation](New-AzureRmPolicyRemediation.md)
30+
Creates a policy remediation.
31+
32+
### [Remove-AzureRmPolicyRemediation](Remove-AzureRmPolicyRemediation.md)
33+
Deletes a completed or canceled policy remediation.
34+
35+
### [Stop-AzureRmPolicyRemediation](Stop-AzureRmPolicyRemediation.md)
36+
Cancels an active policy remediation.
37+

0 commit comments

Comments
 (0)