Skip to content

Commit 0d90585

Browse files
mentat9mentat9
committed
Update help files to correspond to typed parameters
1 parent a3fbbc6 commit 0d90585

7 files changed

+143
-11
lines changed

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

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@ Creates a policy assignment.
1616
### DefaultParameterSet (Default)
1717
```
1818
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
19-
[-Description <String>] [-PolicyDefinition <PSObject>] [-PolicySetDefinition <PSObject>] [-Metadata <String>]
19+
[-Description <String>] [-PolicyDefinition <PsPolicyDefinition>]
20+
[-PolicySetDefinition <PsPolicySetDefinition>] [-Metadata <String>]
2021
[-EnforcementMode <PolicyAssignmentEnforcementMode>] [-AssignIdentity] [-Location <String>]
2122
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2223
```
2324

2425
### PolicyParameterObjectParameterSet
2526
```
2627
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
27-
[-Description <String>] -PolicyDefinition <PSObject> [-PolicySetDefinition <PSObject>]
28+
[-Description <String>] -PolicyDefinition <PsPolicyDefinition> [-PolicySetDefinition <PsPolicySetDefinition>]
2829
-PolicyParameterObject <Hashtable> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
2930
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
3031
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
@@ -33,7 +34,7 @@ New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [
3334
### PolicyParameterStringParameterSet
3435
```
3536
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
36-
[-Description <String>] -PolicyDefinition <PSObject> [-PolicySetDefinition <PSObject>]
37+
[-Description <String>] -PolicyDefinition <PsPolicyDefinition> [-PolicySetDefinition <PsPolicySetDefinition>]
3738
-PolicyParameter <String> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
3839
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
3940
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
@@ -42,7 +43,7 @@ New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [
4243
### PolicySetParameterObjectParameterSet
4344
```
4445
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
45-
[-Description <String>] [-PolicyDefinition <PSObject>] -PolicySetDefinition <PSObject>
46+
[-Description <String>] [-PolicyDefinition <PsPolicyDefinition>] -PolicySetDefinition <PsPolicySetDefinition>
4647
-PolicyParameterObject <Hashtable> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
4748
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
4849
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
@@ -51,7 +52,7 @@ New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [
5152
### PolicySetParameterStringParameterSet
5253
```
5354
New-AzPolicyAssignment -Name <String> [-Scope <String>] [-NotScope <String[]>] [-DisplayName <String>]
54-
[-Description <String>] [-PolicyDefinition <PSObject>] -PolicySetDefinition <PSObject>
55+
[-Description <String>] [-PolicyDefinition <PsPolicyDefinition>] -PolicySetDefinition <PsPolicySetDefinition>
5556
-PolicyParameter <String> [-Metadata <String>] [-EnforcementMode <PolicyAssignmentEnforcementMode>]
5657
[-AssignIdentity] [-Location <String>] [-ApiVersion <String>] [-Pre]
5758
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
@@ -309,7 +310,7 @@ Accept wildcard characters: False
309310
Specifies a policy, as a **PsPolicyDefinition** object that contains the policy rule.
310311
311312
```yaml
312-
Type: System.Management.Automation.PSObject
313+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition
313314
Parameter Sets: DefaultParameterSet
314315
Aliases:
315316

@@ -321,7 +322,7 @@ Accept wildcard characters: False
321322
```
322323
323324
```yaml
324-
Type: System.Management.Automation.PSObject
325+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition
325326
Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet
326327
Aliases:
327328

@@ -333,7 +334,7 @@ Accept wildcard characters: False
333334
```
334335
335336
```yaml
336-
Type: System.Management.Automation.PSObject
337+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition
337338
Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet
338339
Aliases:
339340

@@ -378,7 +379,7 @@ Accept wildcard characters: False
378379
The policy set definition object.
379380
380381
```yaml
381-
Type: System.Management.Automation.PSObject
382+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition
382383
Parameter Sets: DefaultParameterSet
383384
Aliases:
384385

@@ -390,7 +391,7 @@ Accept wildcard characters: False
390391
```
391392
392393
```yaml
393-
Type: System.Management.Automation.PSObject
394+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition
394395
Parameter Sets: PolicyParameterObjectParameterSet, PolicyParameterStringParameterSet
395396
Aliases:
396397

@@ -402,7 +403,7 @@ Accept wildcard characters: False
402403
```
403404
404405
```yaml
405-
Type: System.Management.Automation.PSObject
406+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition
406407
Parameter Sets: PolicySetParameterObjectParameterSet, PolicySetParameterStringParameterSet
407408
Aliases:
408409

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ Remove-AzPolicyAssignment -Id <String> [-ApiVersion <String>] [-Pre] [-DefaultPr
2525
[-WhatIf] [-Confirm] [<CommonParameters>]
2626
```
2727

28+
### InputObjectParameterSet
29+
```
30+
Remove-AzPolicyAssignment -InputObject <PsPolicyAssignment> [-ApiVersion <String>] [-Pre]
31+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
32+
```
33+
2834
## DESCRIPTION
2935
The **Remove-AzPolicyAssignment** cmdlet removes the specified policy assignment.
3036

@@ -101,6 +107,21 @@ Accept pipeline input: True (ByPropertyName)
101107
Accept wildcard characters: False
102108
```
103109
110+
### -InputObject
111+
The policy assignment object to remove that was output from another cmdlet.
112+
113+
```yaml
114+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment
115+
Parameter Sets: InputObjectParameterSet
116+
Aliases:
117+
118+
Required: True
119+
Position: Named
120+
Default value: None
121+
Accept pipeline input: True (ByPropertyName, ByValue)
122+
Accept wildcard characters: False
123+
```
124+
104125
### -Name
105126
Specifies the name of the policy assignment that this cmdlet removes.
106127

‎src/Resources/Resources/help/Remove-AzPolicyDefinition.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ Remove-AzPolicyDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre]
3737
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3838
```
3939

40+
### InputObjectParameterSet
41+
```
42+
Remove-AzPolicyDefinition [-Force] -InputObject <PsPolicyDefinition> [-ApiVersion <String>] [-Pre]
43+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
44+
```
45+
4046
## DESCRIPTION
4147
The **Remove-AzPolicyDefinition** cmdlet removes a policy definition.
4248

@@ -122,6 +128,21 @@ Accept pipeline input: True (ByPropertyName)
122128
Accept wildcard characters: False
123129
```
124130
131+
### -InputObject
132+
The policy definition object to remove that was output from another cmdlet.
133+
134+
```yaml
135+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition
136+
Parameter Sets: InputObjectParameterSet
137+
Aliases:
138+
139+
Required: True
140+
Position: Named
141+
Default value: None
142+
Accept pipeline input: True (ByPropertyName, ByValue)
143+
Accept wildcard characters: False
144+
```
145+
125146
### -ManagementGroupName
126147
The name of the management group of the policy definition to delete.
127148

‎src/Resources/Resources/help/Remove-AzPolicySetDefinition.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ Remove-AzPolicySetDefinition -Id <String> [-Force] [-ApiVersion <String>] [-Pre]
3636
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3737
```
3838

39+
### InputObjectParameterSet
40+
```
41+
Remove-AzPolicySetDefinition [-Force] -InputObject <PsPolicySetDefinition> [-ApiVersion <String>] [-Pre]
42+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
43+
```
44+
3945
## DESCRIPTION
4046
The **Remove-AzPolicySetDefinition** cmdlet removes a policy definition.
4147

@@ -116,6 +122,21 @@ Accept pipeline input: True (ByPropertyName)
116122
Accept wildcard characters: False
117123
```
118124
125+
### -InputObject
126+
The policy set definition object to remove that was output from another cmdlet.
127+
128+
```yaml
129+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition
130+
Parameter Sets: InputObjectParameterSet
131+
Aliases:
132+
133+
Required: True
134+
Position: Named
135+
Default value: None
136+
Accept pipeline input: True (ByPropertyName, ByValue)
137+
Accept wildcard characters: False
138+
```
139+
119140
### -ManagementGroupName
120141
The name of the management group of the policy set definition to delete.
121142

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,14 @@ Set-AzPolicyAssignment [-NotScope <String[]>] -Id <String> [-DisplayName <String
6161
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
6262
```
6363

64+
### InputObjectParameterSet
65+
```
66+
Set-AzPolicyAssignment [-NotScope <String[]>] [-DisplayName <String>] [-Description <String>]
67+
[-Metadata <String>] [-AssignIdentity] [-Location <String>]
68+
[-EnforcementMode <PolicyAssignmentEnforcementMode>] -InputObject <PsPolicyAssignment> [-ApiVersion <String>]
69+
[-Pre] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
70+
```
71+
6472
## DESCRIPTION
6573
The **Set-AzPolicyAssignment** cmdlet modifies a policy assignment.
6674
Specify an assignment by ID or by name and scope.
@@ -248,6 +256,21 @@ Accept pipeline input: True (ByPropertyName)
248256
Accept wildcard characters: False
249257
```
250258
259+
### -InputObject
260+
The policy assignment object to update that was output from another cmdlet.
261+
262+
```yaml
263+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyAssignment
264+
Parameter Sets: InputObjectParameterSet
265+
Aliases:
266+
267+
Required: True
268+
Position: Named
269+
Default value: None
270+
Accept pipeline input: True (ByPropertyName, ByValue)
271+
Accept wildcard characters: False
272+
```
273+
251274
### -Location
252275
The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used.
253276

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ Set-AzPolicyDefinition -Id <String> [-DisplayName <String>] [-Description <Strin
4141
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
4242
```
4343

44+
### InputObjectParameterSet
45+
```
46+
Set-AzPolicyDefinition [-DisplayName <String>] [-Description <String>] [-Policy <String>] [-Metadata <String>]
47+
[-Parameter <String>] [-Mode <String>] -InputObject <PsPolicyDefinition> [-ApiVersion <String>] [-Pre]
48+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
49+
```
50+
4451
## DESCRIPTION
4552
The **Set-AzPolicyDefinition** cmdlet modifies a policy definition.
4653

@@ -158,6 +165,21 @@ Accept pipeline input: True (ByPropertyName)
158165
Accept wildcard characters: False
159166
```
160167
168+
### -InputObject
169+
The policy definition object to update that was output from another cmdlet.
170+
171+
```yaml
172+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicyDefinition
173+
Parameter Sets: InputObjectParameterSet
174+
Aliases:
175+
176+
Required: True
177+
Position: Named
178+
Default value: None
179+
Accept pipeline input: True (ByPropertyName, ByValue)
180+
Accept wildcard characters: False
181+
```
182+
161183
### -ManagementGroupName
162184
The name of the management group of the policy definition to update.
163185

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ Set-AzPolicySetDefinition -Id <String> [-DisplayName <String>] [-Description <St
4444
[<CommonParameters>]
4545
```
4646

47+
### InputObjectParameterSet
48+
```
49+
Set-AzPolicySetDefinition [-DisplayName <String>] [-Description <String>] [-PolicyDefinition <String>]
50+
[-Metadata <String>] [-Parameter <String>] -InputObject <PsPolicySetDefinition> [-GroupDefinition <String>]
51+
[-ApiVersion <String>] [-Pre] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
52+
[<CommonParameters>]
53+
```
54+
4755
## DESCRIPTION
4856
The **Set-AzPolicySetDefinition** cmdlet modifies a policy definition.
4957

@@ -185,6 +193,21 @@ Accept pipeline input: True (ByPropertyName)
185193
Accept wildcard characters: False
186194
```
187195
196+
### -InputObject
197+
The policy set definition object to update that was output from another cmdlet.
198+
199+
```yaml
200+
Type: Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.Policy.PsPolicySetDefinition
201+
Parameter Sets: InputObjectParameterSet
202+
Aliases:
203+
204+
Required: True
205+
Position: Named
206+
Default value: None
207+
Accept pipeline input: True (ByPropertyName, ByValue)
208+
Accept wildcard characters: False
209+
```
210+
188211
### -ManagementGroupName
189212
The name of the management group of the policy set definition to update.
190213

0 commit comments

Comments
 (0)