< Back
Set-AzureRmPolicyDefinition
Post
NAME Set-AzureRmPolicyDefinition
SYNOPSIS
Modifies a policy definition.
SYNTAX
Set-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>] -Id
<String> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Metadata <String>] [-Parameter <String>] [-Policy <String>]
[-Pre] [<CommonParameters>]
Set-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Metadata <String>] -Name <String> [-Parameter <String>] [-Policy
<String>] [-Pre] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmPolicyDefinition cmdlet modifies a policy definition.
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>
Specifies a new description for the policy definition.
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 definition.
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 definition 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
-Metadata <String>
The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the policy definition that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Parameter <String>
The parameters declaration for policy definition. This can either be a path to a file name or uri containing the parameters declaration, or
the parameters declaration as string.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Policy <String>
Specifies new policy rule for the policy definition. You can specify the path of a .json file or a string that contains the policy in
JavaScript Object Notation (JSON) format.
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
<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 description of a policy definition
PS C:\\>$PolicyDefinition = Get-AzureRmPolicyDefinition -Name "VMPolicyDefinition"
PS C:\\> Set-AzureRmPolicyDefinition -Id $Policy.ResourceId -Description "Updated policy to not allow virtual machine creation"
The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. The command stores that
object in the $PolicyDefinition variable.
The second command updates the description of the policy definition identified by the ResourceId property of $PolicyDefinition.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... definition
Get-AzureRmPolicyDefinition
New-AzureRmPolicyDefinition
Remove-AzureRmPolicyDefinition
SYNOPSIS
Modifies a policy definition.
SYNTAX
Set-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>] -Id
<String> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Metadata <String>] [-Parameter <String>] [-Policy <String>]
[-Pre] [<CommonParameters>]
Set-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-DisplayName <String>]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Metadata <String>] -Name <String> [-Parameter <String>] [-Policy
<String>] [-Pre] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmPolicyDefinition cmdlet modifies a policy definition.
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>
Specifies a new description for the policy definition.
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 definition.
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 definition 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
-Metadata <String>
The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the policy definition that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Parameter <String>
The parameters declaration for policy definition. This can either be a path to a file name or uri containing the parameters declaration, or
the parameters declaration as string.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Policy <String>
Specifies new policy rule for the policy definition. You can specify the path of a .json file or a string that contains the policy in
JavaScript Object Notation (JSON) format.
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
<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 description of a policy definition
PS C:\\>$PolicyDefinition = Get-AzureRmPolicyDefinition -Name "VMPolicyDefinition"
PS C:\\> Set-AzureRmPolicyDefinition -Id $Policy.ResourceId -Description "Updated policy to not allow virtual machine creation"
The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. The command stores that
object in the $PolicyDefinition variable.
The second command updates the description of the policy definition identified by the ResourceId property of $PolicyDefinition.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... definition
Get-AzureRmPolicyDefinition
New-AzureRmPolicyDefinition
Remove-AzureRmPolicyDefinition