Secured Masking Rule (MaskingRule) table/entity reference (Microsoft Dataverse)

2025-08-28

Secured Masking Rules to apply to fields.

Messages

The following table lists the messages for the Secured Masking Rule (MaskingRule) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Associate` Event: True	Associate records	Associate records
`Create` Event: True	`POST` /maskingrules See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /maskingrules(maskingruleid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`Retrieve` Event: True	`GET` /maskingrules(maskingruleid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /maskingrules See Query data	Query data
`Update` Event: True	`PATCH` /maskingrules(maskingruleid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /maskingrules(maskingruleid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the Secured Masking Rule (MaskingRule) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
`BulkRetain`	BulkRetain	Learn to use messages with the SDK for .NET
`PurgeRetainedContent`	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Retain`	Retain	Learn to use messages with the SDK for .NET
`RollbackRetain`	RollbackRetain	Learn to use messages with the SDK for .NET
`ValidateRetentionConfig`	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Secured Masking Rule (MaskingRule) table.

Property	Value
DisplayName	Secured Masking Rule
DisplayCollectionName	Secured Masking Rules
SchemaName	`MaskingRule`
CollectionSchemaName	`maskingrules`
EntitySetName	`maskingrules`
LogicalName	`maskingrule`
LogicalCollectionName	`maskingrules`
PrimaryIdAttribute	`maskingruleid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

Description
DisplayName
IsCustomizable
MaskedCharacter
MaskedRichTestData
MaskedTestData
MaskingRuleId
Name
RegularExpression
RichTestData
TestData
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

Description

Property	Value
Description	Description of the secured masking rule
DisplayName	Description
IsValidForForm	True
IsValidForRead	True
LogicalName	`description`
RequiredLevel	SystemRequired
Type	String
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	True
MaxLength	500

DisplayName

Property	Value
Description	The display name of the secured masking rule.
DisplayName	Display Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`displayname`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	True
MaxLength	100

IsCustomizable

Property	Value
Description	For internal use only.
DisplayName	Is Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	`iscustomizable`
RequiredLevel	SystemRequired
Type	ManagedProperty

MaskedCharacter

Property	Value
Description	Character used to mask
DisplayName	Masked Character
IsValidForForm	True
IsValidForRead	True
LogicalName	`maskedcharacter`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1

MaskedRichTestData

Property	Value
Description	Rich text test data evaluated by a secured masking rule
DisplayName	Masked Rich Text Test Data
IsValidForForm	True
IsValidForRead	True
LogicalName	`maskedrichtestdata`
RequiredLevel	None
Type	String
Format	Text
FormatName	RichText
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

MaskedTestData

Property	Value
Description	Test data evaluated by a secured masking rule
DisplayName	Masked Test Data
IsValidForForm	True
IsValidForRead	True
LogicalName	`maskedtestdata`
RequiredLevel	None
Type	String
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

MaskingRuleId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Masking Rule
IsValidForForm	False
IsValidForRead	True
LogicalName	`maskingruleid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

Name

Property	Value
Description	The unique name of the secured masking rule.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`name`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

RegularExpression

Property	Value
Description	Regular Expression in C#
DisplayName	Regular Expression
IsValidForForm	True
IsValidForRead	True
LogicalName	`regularexpression`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

RichTestData

Property	Value
Description	Rich text test data to evaluate a secured masking rule
DisplayName	Enter Rich Text Test Data
IsValidForForm	True
IsValidForRead	True
LogicalName	`richtestdata`
RequiredLevel	None
Type	String
Format	Text
FormatName	RichText
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

TestData

Property	Value
Description	Test data to evaluate a secured masking rule
DisplayName	Enter Test Data
IsValidForForm	True
IsValidForRead	True
LogicalName	`testdata`
RequiredLevel	None
Type	String
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`timezoneruleversionnumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	`utcconversiontimezonecode`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

ComponentIdUnique
ComponentState
CreatedBy
CreatedOn
CreatedOnBehalfBy
IsManaged
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
OverwriteTime
SolutionId
SupportingSolutionId

ComponentIdUnique

Property	Value
Description	For internal use only.
DisplayName	Row id unique
IsValidForForm	False
IsValidForRead	True
LogicalName	`componentidunique`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	`componentstate`
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue
GlobalChoiceName	`componentstate`

ComponentState Choices/Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets

IsManaged

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	`ismanaged`
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	`ismanaged`
DefaultValue	False
True Label	Managed
False Label	Unmanaged

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	None
Type	Lookup
Targets	organization

OverwriteTime

Property	Value
Description	For internal use only.
DisplayName	Record Overwrite Time
IsValidForForm	False
IsValidForRead	True
LogicalName	`overwritetime`
RequiredLevel	SystemRequired
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

SolutionId

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	`solutionid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	`supportingsolutionid`
RequiredLevel	None
Type	Uniqueidentifier

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

organization_maskingrule

One-To-Many Relationship: organization organization_maskingrule

Property	Value
ReferencedEntity	`organization`
ReferencedAttribute	`organizationid`
ReferencingAttribute	`organizationid`
ReferencingEntityNavigationPropertyName	`organizationid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

maskingrule_AsyncOperations
maskingrule_attributemaskingrule
maskingrule_BulkDeleteFailures
maskingrule_DuplicateBaseRecord
maskingrule_DuplicateMatchingRecord
maskingrule_MailboxTrackingFolders
maskingrule_PrincipalObjectAttributeAccesses
maskingrule_ProcessSession
maskingrule_SyncErrors

maskingrule_AsyncOperations

Many-To-One Relationship: asyncoperation maskingrule_AsyncOperations

Property	Value
ReferencingEntity	`asyncoperation`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`maskingrule_AsyncOperations`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_attributemaskingrule

Many-To-One Relationship: attributemaskingrule maskingrule_attributemaskingrule

Property	Value
ReferencingEntity	`attributemaskingrule`
ReferencingAttribute	`maskingruleid`
ReferencedEntityNavigationPropertyName	`maskingrule_attributemaskingrule`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure maskingrule_BulkDeleteFailures

Property	Value
ReferencingEntity	`bulkdeletefailure`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`maskingrule_BulkDeleteFailures`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord maskingrule_DuplicateBaseRecord

Property	Value
ReferencingEntity	`duplicaterecord`
ReferencingAttribute	`baserecordid`
ReferencedEntityNavigationPropertyName	`maskingrule_DuplicateBaseRecord`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord maskingrule_DuplicateMatchingRecord

Property	Value
ReferencingEntity	`duplicaterecord`
ReferencingAttribute	`duplicaterecordid`
ReferencedEntityNavigationPropertyName	`maskingrule_DuplicateMatchingRecord`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder maskingrule_MailboxTrackingFolders

Property	Value
ReferencingEntity	`mailboxtrackingfolder`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`maskingrule_MailboxTrackingFolders`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess maskingrule_PrincipalObjectAttributeAccesses

Property	Value
ReferencingEntity	`principalobjectattributeaccess`
ReferencingAttribute	`objectid`
ReferencedEntityNavigationPropertyName	`maskingrule_PrincipalObjectAttributeAccesses`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_ProcessSession

Many-To-One Relationship: processsession maskingrule_ProcessSession

Property	Value
ReferencingEntity	`processsession`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`maskingrule_ProcessSession`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

maskingrule_SyncErrors

Many-To-One Relationship: syncerror maskingrule_SyncErrors

Property	Value
ReferencingEntity	`syncerror`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`maskingrule_SyncErrors`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Feedback

Was this page helpful?