Skip to content

Commit 886184b

Browse files
pilorpilor
committed
Update help docs
1 parent 280bbf4 commit 886184b

File tree

3 files changed

+89
-26
lines changed

3 files changed

+89
-26
lines changed

‎src/Resources/Resources/help/Get-AzPolicyAssignment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
202202
203203
## OUTPUTS
204204
205-
### System.Management.Automation.PSObject
205+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment
206206
207207
## NOTES
208208

‎src/Resources/Resources/help/New-AzPolicyAssignment.md

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,43 +19,44 @@ New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [
1919
[-Description <String>] [-PolicyDefinition <PsPolicyDefinition>]
2020
[-PolicySetDefinition <PsPolicySetDefinition>] [-Metadata <String>]
2121
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-AssignIdentity] [-Location <String>]
22-
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
22+
[-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre]
23+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2324
```
2425

2526
### PolicyParameterObjectParameterSet
2627
```
2728
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
2829
[-Description <String>] -PolicyDefinition <PsPolicyDefinition> [-PolicySetDefinition <PsPolicySetDefinition>]
2930
-PolicyParameterObject <Hashtable> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
30-
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
31-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
31+
[-AssignIdentity] [-Location <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
32+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3233
```
3334

3435
### PolicyParameterStringParameterSet
3536
```
3637
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
3738
[-Description <String>] -PolicyDefinition <PsPolicyDefinition> [-PolicySetDefinition <PsPolicySetDefinition>]
3839
-PolicyParameter <String> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
39-
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
40-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
40+
[-AssignIdentity] [-Location <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
41+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
4142
```
4243

4344
### PolicySetParameterObjectParameterSet
4445
```
4546
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
4647
[-Description <String>] [-PolicyDefinition <PsPolicyDefinition>] -PolicySetDefinition <PsPolicySetDefinition>
4748
-PolicyParameterObject <Hashtable> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
48-
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
49-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
49+
[-AssignIdentity] [-Location <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
50+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
5051
```
5152

5253
### PolicySetParameterStringParameterSet
5354
```
5455
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
5556
[-Description <String>] [-PolicyDefinition <PsPolicyDefinition>] -PolicySetDefinition <PsPolicySetDefinition>
5657
-PolicyParameter <String> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
57-
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
58-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
58+
[-AssignIdentity] [-Location <String>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
59+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
5960
```
6061

6162
## DESCRIPTION
@@ -152,6 +153,15 @@ The second command gets the policy definition named VirtualMachinePolicy by usin
152153
The final command assigns the policy in $Policy at the level of the subscription identified by the subscription scope string.
153154
The assignment is set with an EnforcementMode value of _DoNotEnforce_ i.e. the policy effect is not enforced during resource creation or update.
154155

156+
### Example 7: Policy assignment with non-compliance messages
157+
```
158+
PS C:\> $Policy = Get-AzPolicyDefinition -Name 'VirtualMachinePolicy'
159+
PS C:\> New-AzPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -PolicyDefinition $Policy -NonComplianceMessage @{Message="All resources must follow resource naming guidelines."}
160+
```
161+
162+
The first command gets the policy definition named VirtualMachinePolicy by using the Get-AzPolicyDefinition cmdlet and stores it in the $Policy variable.
163+
The seccomd command assigns the policy in $Policy to the subscription with a non-compliance message that will be shown when the policy denies a resource creation.
164+
155165
## PARAMETERS
156166

157167
### -ApiVersion
@@ -291,6 +301,21 @@ Accept pipeline input: True (ByPropertyName)
291301
Accept wildcard characters: False
292302
```
293303
304+
### -NonComplianceMessage
305+
The non-compliance messages that describe why a resource is non-compliant with the policy.
306+
307+
```yaml
308+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[]
309+
Parameter Sets: (All)
310+
Aliases:
311+
312+
Required: False
313+
Position: Named
314+
Default value: None
315+
Accept pipeline input: True (ByPropertyName)
316+
Accept wildcard characters: False
317+
```
318+
294319
### -NotScope
295320
The not scopes for policy assignment.
296321
@@ -455,11 +480,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
455480

456481
### System.String[]
457482

458-
### System.Management.Automation.PSObject
483+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition
484+
485+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition
486+
487+
### System.Nullable`1[[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyAssignmentEnforcementMode, Microsoft.Azure.PowerShell.Cmdlets.ResourceManager, Version=3.5.0.0, Culture=neutral, PublicKeyToken=null]]
488+
489+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[]
459490

460491
## OUTPUTS
461492

462-
### System.Management.Automation.PSObject
493+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment
463494

464495
## NOTES
465496

‎src/Resources/Resources/help/Set-AzPolicyAssignment.md

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,56 +17,58 @@ Modifies a policy assignment.
1717
```
1818
Set-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
1919
[-Description <String>] [-Metadata <String>] [-AssignIdentity] [-Location <String>]
20-
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-ApiVersion <String>] [-Pre]
21-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
20+
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
21+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2222
```
2323

2424
### PolicyParameterNameObjectParameterSet
2525
```
2626
Set-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
2727
[-Description <String>] [-Metadata <String>] -PolicyParameterObject <Hashtable> [-AssignIdentity]
28-
[-Location <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>] [-ApiVersion <String>] [-Pre]
28+
[-Location <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
29+
[-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre]
2930
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3031
```
3132

3233
### PolicyParameterNameStringParameterSet
3334
```
3435
Set-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
3536
[-Description <String>] [-Metadata <String>] -PolicyParameter <String> [-AssignIdentity] [-Location <String>]
36-
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-ApiVersion <String>] [-Pre]
37-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
37+
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
38+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3839
```
3940

4041
### IdParameterSet
4142
```
4243
Set-AzPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>]
4344
[-Metadata <String>] [-AssignIdentity] [-Location <String>]
44-
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-ApiVersion <String>] [-Pre]
45-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
45+
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
46+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
4647
```
4748

4849
### PolicyParameterIdObjectParameterSet
4950
```
5051
Set-AzPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>]
5152
[-Metadata <String>] -PolicyParameterObject <Hashtable> [-AssignIdentity] [-Location <String>]
52-
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-ApiVersion <String>] [-Pre]
53-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
53+
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
54+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
5455
```
5556

5657
### PolicyParameterIdStringParameterSet
5758
```
5859
Set-AzPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String>] [-Description <String>]
5960
[-Metadata <String>] -PolicyParameter <String> [-AssignIdentity] [-Location <String>]
60-
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-ApiVersion <String>] [-Pre]
61-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
61+
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-NonComplianceMessage <PsNonComplianceMessage[]>]
62+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
6263
```
6364

6465
### InputObjectParameterSet
6566
```
6667
Set-AzPolicyAssignment [-NotScope <String[]>] [-DisplayName <String>] [-Description <String>]
6768
[-Metadata <String>] [-AssignIdentity] [-Location <String>]
68-
[-EnforcementMode <PolicyAssignmentEnforcementMode>] -InputObject <PsPolicyAssignment> [-ApiVersion <String>]
69-
[-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
69+
[-EnforcementMode <PolicyAssignmentEnforcementMode>] -InputObject <PsPolicyAssignment>
70+
[-NonComplianceMessage <PsNonComplianceMessage[]>] [-ApiVersion <String>] [-Pre]
71+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
7072
```
7173

7274
## DESCRIPTION
@@ -147,6 +149,15 @@ The second command gets the policy assignment named PolicyAssignment by using th
147149
The command stores that object in the $PolicyAssignment variable.
148150
The final command updates the enforcementMode property on the policy assignment on the resource group identified by the **ResourceId** property of $ResourceGroup.
149151

152+
### Example 6: Update non-compliance messages
153+
```
154+
PS C:\> $PolicyAssignment = Get-AzPolicyAssignment -Name 'VirtualMachinePolicy'
155+
PS C:\> Set-AzPolicyAssignment -Id $PolicyAssignment.ResourceId -NonComplianceMessage @{Message="All resources must follow resource naming guidelines."},
156+
```
157+
158+
The first command gets the policy assignment named VirtualMachinePolicy by using the Get-AzPolicyAssignment cmdlet and stores it in the $PolicyAssignment variable.
159+
The final command updates the non-compliance messages on the policy assignment with a new message that will be displayed if a resource is denied by the policy.
160+
150161
## PARAMETERS
151162

152163
### -ApiVersion
@@ -316,6 +327,21 @@ Accept pipeline input: True (ByPropertyName)
316327
Accept wildcard characters: False
317328
```
318329
330+
### -NonComplianceMessage
331+
The non-compliance messages that describe why a resource is non-compliant with the policy.
332+
333+
```yaml
334+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[]
335+
Parameter Sets: (All)
336+
Aliases:
337+
338+
Required: False
339+
Position: Named
340+
Default value: None
341+
Accept pipeline input: True (ByPropertyName)
342+
Accept wildcard characters: False
343+
```
344+
319345
### -NotScope
320346
The policy assignment not scopes.
321347
@@ -400,9 +426,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
400426
401427
### System.String[]
402428
429+
### System.Nullable`1[[Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy.PolicyAssignmentEnforcementMode, Microsoft.Azure.PowerShell.Cmdlets.ResourceManager, Version=3.5.0.0, Culture=neutral, PublicKeyToken=null]]
430+
431+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment
432+
433+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsNonComplianceMessage[]
434+
403435
## OUTPUTS
404436

405-
### System.Management.Automation.PSObject
437+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment
406438

407439
## NOTES
408440

0 commit comments

Comments
 (0)