Language

PolicyEnrollmentProperties Class

Definition

The policy enrollment properties.

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

Constructors

Name Description
PolicyEnrollmentProperties()

Creates an new PolicyEnrollmentProperties instance.

Properties

Name Description
AssignmentScopeValidation

The option whether to validate the enrollment is at or under the assignment scope.

Description

The description of the policy enrollment.

DisplayName

The display name of the policy enrollment.

Metadata

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

PolicyAssignmentId

The ID of the policy assignment that is being enrolled.

PolicyAssignmentInstanceId

The policy assignment instance ID associated with this enrollment. The value is set to the instance ID of the policy assignment the policyAssignmentId references when the enrollment is created or updated. The format is a GUID string.

PolicyDefinitionReferenceId

The policy definition reference IDs for policy definitions in an assigned policy set definition. These IDs correspond to a subset of policyDefinitions[*].policyDefinitionReferenceId in the policy set definition. When specified and not empty, only the referenced policy definitions will be enrolled to. Otherwise, the entire policy set is enrolled to

ResourceSelector

The resource selector list to filter policies by resource properties.

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PolicyEnrollmentProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PolicyEnrollmentProperties.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of PolicyEnrollmentProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to