Language

PolicyAssignmentProperties Class

Definition

The policy assignment properties.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.PolicyAssignmentPropertiesTypeConverter))]
public class PolicyAssignmentProperties : Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicyAssignmentProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.PolicyAssignmentPropertiesTypeConverter))>]
type PolicyAssignmentProperties = class
    interface IPolicyAssignmentProperties
    interface IJsonSerializable
Public Class PolicyAssignmentProperties
Implements IPolicyAssignmentProperties
Inheritance
PolicyAssignmentProperties
Attributes
Implements

Constructors

Name Description
PolicyAssignmentProperties()

Creates an new PolicyAssignmentProperties instance.

Properties

Name Description
AssignmentType

The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable.

DefinitionVersion

The version of the policy definition to use.

Description

This message will be part of response in case of policy violation.

DisplayName

The display name of the policy assignment.

EffectiveDefinitionVersion

The effective version of the policy definition in use. This is only present if requested via the $expand query parameter.

EnforcementMode

The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll

InstanceId

The instance ID of the policy assignment. This ID only and always changes when the assignment is deleted and recreated.

LatestDefinitionVersion

The latest version of the policy definition available. This is only present if requested via the $expand query parameter.

Metadata

The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.

NonComplianceMessage

The messages that describe why a resource is non-compliant with the policy.

NotScope

The policy's excluded scopes.

Override

The policy property value override.

Parameter

The parameter values for the assigned policy rule. The keys are the parameter names.

PolicyDefinitionId

The ID of the policy definition or policy set definition being assigned.

ResourceSelector

The resource selector list to filter policies by resource properties.

Scope

The scope for the policy assignment.

SelfServeExemptionSettingEnabled

Indicates whether self-serve exemption is enabled.

SelfServeExemptionSettingPolicyDefinitionReferenceId

The policy definition reference IDs for self-serve exemption.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PolicyAssignmentProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PolicyAssignmentProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicyAssignmentProperties.

FromJsonString(String)

Creates a new instance of PolicyAssignmentProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of PolicyAssignmentProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to