Language

PolicyEnrollment Class

Definition

The policy enrollment.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.PolicyEnrollmentTypeConverter))]
public class PolicyEnrollment : Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicyEnrollment, Microsoft.Azure.PowerShell.Cmdlets.Policy.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.PolicyEnrollmentTypeConverter))>]
type PolicyEnrollment = class
    interface IPolicyEnrollment
    interface IJsonSerializable
    interface IExtensionResource
    interface IResource
    interface IValidates
Public Class PolicyEnrollment
Implements IPolicyEnrollment, IValidates
Inheritance
PolicyEnrollment
Attributes
Implements

Constructors

Name Description
PolicyEnrollment()

Creates an new PolicyEnrollment 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.

ETag

The ETag for the policy enrollment.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Metadata

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

Name

The name of the resource

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.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name Description
DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of PolicyEnrollment.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of PolicyEnrollment.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of PolicyEnrollment into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to