Skip to content

Commit 998aa80

Browse files
author
Maddie Clayton
authored
Merge pull request #7828 from pilor/policyLocHelp
Update Microsoft.Authorization/policyAssignments MSI help
2 parents 4d78c54 + f86ab80 commit 998aa80

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Implementation/Policy/PolicyHelpStrings.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ public static class PolicyHelpStrings
4747
public const string SetPolicyAssignmentDescriptionHelp = "The description of the updated policy assignment";
4848
public const string SetPolicyAssignmentMetadataHelp = "The updated metadata for the policy assignment. This can either be a path to a file name containing the metadata, or the metadata as a string.";
4949
public const string SetPolicyAssignmentSkuHelp = "A hash table which specifies sku properties. This parameter is deprecated and ignored.";
50-
public const string PolicyAssignmentAssignIdentityHelp = "Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies.";
51-
public const string PolicyAssignmentLocationHelp = "The location of the policy assignment. This is only required when the policy assignment has a resource identity.";
50+
public const string PolicyAssignmentAssignIdentityHelp = "Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies. Location is required when assigning an identity.";
51+
public const string PolicyAssignmentLocationHelp = "The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used.";
5252

5353
/// <summary>
5454
/// Policy definition cmdlet parameter help strings

src/ResourceManager/Resources/Commands.Resources/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Additional information about change #1
1919
-->
2020
## Current Release
21+
* Update help documentation for resource identity related parameters in `New-AzureRmPolicyAssignment` and `Set-AzureRmPolicyAssignment`
2122
* Add an example for New-AzureRmPolicyDefinition that uses -Metadata
2223
* Fix to allow case preservation in Tag keys in NetStandard: #7678 #7703
2324

src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyAssignment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ PS C:\> New-AzureRmPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -Poli
127127

128128
The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet and stores it in the $ResourceGroup variable.
129129
The second command gets the policy definition named VirtualMachinePolicy by using the Get-AzureRmPolicyDefinition cmdlet and stores it in the $Policy variable.
130-
The final command assigns the policy in $Policy to the resource gruop. A managed identity is automatically created and assigned to the policy assignment.
130+
The final command assigns the policy in $Policy to the resource group. A managed identity is automatically created and assigned to the policy assignment.
131131

132132
## PARAMETERS
133133

@@ -148,7 +148,7 @@ Accept wildcard characters: False
148148
```
149149
150150
### -AssignIdentity
151-
Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies.
151+
Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies. Location is required when assigning an identity.
152152
153153
```yaml
154154
Type: System.Management.Automation.SwitchParameter
@@ -245,7 +245,7 @@ Accept wildcard characters: False
245245
```
246246
247247
### -Location
248-
The location of the policy assignment. This is only required when the policy assignment has a resource identity.
248+
The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used.
249249
250250
```yaml
251251
Type: System.String

src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyAssignment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Accept wildcard characters: False
7777
```
7878
7979
### -AssignIdentity
80-
Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies.
80+
Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies. Location is required when assigning an identity.
8181
8282
```yaml
8383
Type: System.Management.Automation.SwitchParameter
@@ -189,7 +189,7 @@ Accept wildcard characters: False
189189
```
190190
191191
### -Location
192-
The location of the policy assignment. This is only required when the policy assignment has a resource identity.
192+
The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used.
193193
194194
```yaml
195195
Type: System.String

0 commit comments

Comments
 (0)