Skip to content

Commit

Permalink
Merge pull request #7828 from pilor/policyLocHelp
Browse files Browse the repository at this point in the history
Update Microsoft.Authorization/policyAssignments MSI help
  • Loading branch information
Maddie Clayton authored Nov 14, 2018
2 parents 4d78c54 + f86ab80 commit 998aa80
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ public static class PolicyHelpStrings
public const string SetPolicyAssignmentDescriptionHelp = "The description of the updated policy assignment";
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.";
public const string SetPolicyAssignmentSkuHelp = "A hash table which specifies sku properties. This parameter is deprecated and ignored.";
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.";
public const string PolicyAssignmentLocationHelp = "The location of the policy assignment. This is only required when the policy assignment has a resource identity.";
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.";
public const string PolicyAssignmentLocationHelp = "The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used.";

/// <summary>
/// Policy definition cmdlet parameter help strings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- Additional information about change #1
-->
## Current Release
* Update help documentation for resource identity related parameters in `New-AzureRmPolicyAssignment` and `Set-AzureRmPolicyAssignment`
* Add an example for New-AzureRmPolicyDefinition that uses -Metadata
* Fix to allow case preservation in Tag keys in NetStandard: #7678 #7703

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ PS C:\> New-AzureRmPolicyAssignment -Name 'VirtualMachinePolicyAssignment' -Poli

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

## PARAMETERS

Expand All @@ -148,7 +148,7 @@ Accept wildcard characters: False
```
### -AssignIdentity
Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies.
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.
```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down Expand Up @@ -245,7 +245,7 @@ Accept wildcard characters: False
```
### -Location
The location of the policy assignment. This is only required when the policy assignment has a resource identity.
The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used.
```yaml
Type: System.String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Accept wildcard characters: False
```
### -AssignIdentity
Generate and assign an Azure Active Directory Identity for this policy assignment. The identity will be used when executing deployments for 'deployIfNotExists' policies.
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.
```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down Expand Up @@ -189,7 +189,7 @@ Accept wildcard characters: False
```
### -Location
The location of the policy assignment. This is only required when the policy assignment has a resource identity.
The location of the policy assignment's resource identity. This is required when the -AssignIdentity switch is used.
```yaml
Type: System.String
Expand Down

0 comments on commit 998aa80

Please sign in to comment.