< Back
Set-AzureRmPolicyAssignment
Post
NAME Set-AzureRmPolicyAssignment
SYNOPSIS
Modifies a policy assignment.
SYNTAX
Set-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>] -Id
<String> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Pre] [-Sku <Hashtable>] [<CommonParameters>]
Set-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] -Name <String> [-NotScope <String[]>] [-Pre] -Scope <String> [-Sku
<Hashtable>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmPolicyAssignment cmdlet modifies a policy assignment. Specify an assignment by ID or by name and scope.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
The description for policy assignment
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DisplayName <String>
Specifies a new display name for the policy assignment.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Id <String>
Specifies the fully qualified resource ID for the policy assignment that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the policy assignment that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NotScope <String[]>
The policy assignment not scopes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Scope <String>
Specifies the scope at which the policy is applied.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <Hashtable>
A hash table which represents sku properties.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Management.Automation.PSObject
NOTES
Example 1: Update the display name
PS C:\\>$ResourceGroup = Get-AzureRmResourceGroup -Name "ResourceGroup11"
PS C:\\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name "PolicyAssignment" -Scope $ResourceGroup.ResourceId
PS C:\\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -DisplayName "Do not allow VM creation"
The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. The command stores that object in the
$ResourceGroup variable.
The second command gets the policy assignment named PolicyAssignment by using the Get-AzureRmPolicyAssignment cmdlet. The command stores that
object in the $PolicyAssignment variable.
The final command updates the display name on the policy assignment identified by the ResourceId property of $PolicyAssignment.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... assignment
Get-AzureRmPolicyAssignment
New-AzureRmPolicyAssignment
Remove-AzureRmPolicyAssignment
SYNOPSIS
Modifies a policy assignment.
SYNTAX
Set-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>] -Id
<String> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Pre] [-Sku <Hashtable>] [<CommonParameters>]
Set-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] -Name <String> [-NotScope <String[]>] [-Pre] -Scope <String> [-Sku
<Hashtable>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmPolicyAssignment cmdlet modifies a policy assignment. Specify an assignment by ID or by name and scope.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
The description for policy assignment
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DisplayName <String>
Specifies a new display name for the policy assignment.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Id <String>
Specifies the fully qualified resource ID for the policy assignment that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the policy assignment that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NotScope <String[]>
The policy assignment not scopes.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Scope <String>
Specifies the scope at which the policy is applied.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <Hashtable>
A hash table which represents sku properties.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Management.Automation.PSObject
NOTES
Example 1: Update the display name
PS C:\\>$ResourceGroup = Get-AzureRmResourceGroup -Name "ResourceGroup11"
PS C:\\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name "PolicyAssignment" -Scope $ResourceGroup.ResourceId
PS C:\\> Set-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -DisplayName "Do not allow VM creation"
The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. The command stores that object in the
$ResourceGroup variable.
The second command gets the policy assignment named PolicyAssignment by using the Get-AzureRmPolicyAssignment cmdlet. The command stores that
object in the $PolicyAssignment variable.
The final command updates the display name on the policy assignment identified by the ResourceId property of $PolicyAssignment.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... assignment
Get-AzureRmPolicyAssignment
New-AzureRmPolicyAssignment
Remove-AzureRmPolicyAssignment