Secured Masking Rule (MaskingRule) table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Secured Masking Rules to apply to fields.
Added by: Column Level Security Solution
Messages
Message | Web API Operation | SDK class or method |
---|---|---|
BulkRetain | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
Create | POST /maskingrules See Create |
CreateRequest or Create |
CreateMultiple | CreateMultipleRequest | |
Delete | DELETE /maskingrules(maskingruleid) See Delete |
DeleteRequest or Delete |
PurgeRetainedContent | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
Retain | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
Retrieve | GET /maskingrules(maskingruleid) See Retrieve |
RetrieveRequest or Retrieve |
RetrieveMultiple | GET /maskingrules See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
RollbackRetain | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
Update | PATCH /maskingrules(maskingruleid) See Update |
UpdateRequest or Update |
UpdateMultiple | UpdateMultipleRequest | |
ValidateRetentionConfig | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. |
Properties
Property | Value |
---|---|
CollectionSchemaName | maskingrules |
DisplayCollectionName | Secured Masking Rules |
DisplayName | Secured Masking Rule |
EntitySetName | maskingrules |
IsBPFEntity | False |
LogicalCollectionName | maskingrules |
LogicalName | maskingrule |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | maskingruleid |
PrimaryNameAttribute | name |
SchemaName | MaskingRule |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- Description
- DisplayName
- IsCustomizable
- MaskedCharacter
- MaskedTestData
- MaskingRuleId
- Name
- RegularExpression
- TestData
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
Description
Property | Value |
---|---|
Description | Description of the secured masking rule |
DisplayName | Description |
FormatName | TextArea |
IsLocalizable | True |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | description |
MaxLength | 500 |
RequiredLevel | SystemRequired |
Type | String |
DisplayName
Property | Value |
---|---|
Description | The display name of the secured masking rule. |
DisplayName | Display Name |
FormatName | Text |
IsLocalizable | True |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | displayname |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
IsCustomizable
Added by: Basic Solution Solution
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 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | maskedcharacter |
MaxLength | 1 |
RequiredLevel | SystemRequired |
Type | String |
MaskedTestData
Property | Value |
---|---|
Description | Test data evaluated by a secured masking rule |
DisplayName | Masked Test Data |
FormatName | TextArea |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | maskedtestdata |
MaxLength | 4000 |
RequiredLevel | None |
Type | String |
MaskingRuleId
Property | Value |
---|---|
Description | Unique identifier for entity instances |
DisplayName | Masking Rule |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | maskingruleid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Name
Property | Value |
---|---|
Description | The unique name of the secured masking rule. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | name |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
RegularExpression
Property | Value |
---|---|
Description | Regular Expression in C# |
DisplayName | Regular Expression |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | regularexpression |
MaxLength | 500 |
RequiredLevel | SystemRequired |
Type | String |
TestData
Property | Value |
---|---|
Description | Test data to evaluate a secured masking rule |
DisplayName | Enter Test Data |
FormatName | TextArea |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | testdata |
MaxLength | 4000 |
RequiredLevel | None |
Type | String |
TimeZoneRuleVersionNumber
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Time Zone Rule Version Number |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | timezoneruleversionnumber |
MaxValue | 2147483647 |
MinValue | -1 |
RequiredLevel | None |
Type | Integer |
UTCConversionTimeZoneCode
Property | Value |
---|---|
Description | Time zone code that was in use when the record was created. |
DisplayName | UTC Conversion Time Zone Code |
Format | None |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | utcconversiontimezonecode |
MaxValue | 2147483647 |
MinValue | -1 |
RequiredLevel | None |
Type | Integer |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OrganizationIdName
- OverwriteTime
- SolutionId
- SupportingSolutionId
ComponentIdUnique
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Row id unique |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentidunique |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
ComponentState
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
ComponentState Choices/Options
Value | Label | Description |
---|---|---|
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 |
Targets | |
Type | Lookup |
CreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the record was created. |
DisplayName | Created On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
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 |
Targets | |
Type | Lookup |
IsManaged
Added by: Basic Solution Solution
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 |
IsManaged Choices/Options
Value | Label | Description |
---|---|---|
1 | Managed | |
0 | Unmanaged |
DefaultValue: 0
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who modified the record. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Targets | |
Type | Lookup |
ModifiedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Date and time when the record was modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
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 |
Targets | |
Type | Lookup |
OrganizationId
Property | Value |
---|---|
Description | Unique identifier for the organization |
DisplayName | Organization Id |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationid |
RequiredLevel | None |
Targets | organization |
Type | Lookup |
OrganizationIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationidname |
MaxLength | 160 |
RequiredLevel | None |
Type | String |
OverwriteTime
Added by: Basic Solution Solution
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | For internal use only. |
DisplayName | Record Overwrite Time |
Format | DateAndTime |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overwritetime |
RequiredLevel | SystemRequired |
Type | DateTime |
SolutionId
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | Unique identifier of the associated solution. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | solutionid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
SupportingSolutionId
Added by: Basic Solution Solution
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | False |
LogicalName | supportingsolutionid |
RequiredLevel | None |
Type | Uniqueidentifier |
One-To-Many Relationships
Listed by SchemaName.
- maskingrule_SyncErrors
- maskingrule_DuplicateMatchingRecord
- maskingrule_DuplicateBaseRecord
- maskingrule_AsyncOperations
- maskingrule_MailboxTrackingFolders
- maskingrule_ProcessSession
- maskingrule_BulkDeleteFailures
- maskingrule_PrincipalObjectAttributeAccesses
- maskingrule_attributemaskingrule
maskingrule_SyncErrors
Added by: System Solution Solution
Same as the maskingrule_SyncErrors many-to-one relationship for the syncerror table/entity.
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_SyncErrors |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_DuplicateMatchingRecord
Added by: System Solution Solution
Same as the maskingrule_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord table/entity.
Property | Value |
---|---|
ReferencingEntity | duplicaterecord |
ReferencingAttribute | duplicaterecordid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_DuplicateMatchingRecord |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_DuplicateBaseRecord
Added by: System Solution Solution
Same as the maskingrule_DuplicateBaseRecord many-to-one relationship for the duplicaterecord table/entity.
Property | Value |
---|---|
ReferencingEntity | duplicaterecord |
ReferencingAttribute | baserecordid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_DuplicateBaseRecord |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_AsyncOperations
Added by: System Solution Solution
Same as the maskingrule_AsyncOperations many-to-one relationship for the asyncoperation table/entity.
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_AsyncOperations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_MailboxTrackingFolders
Added by: System Solution Solution
Same as the maskingrule_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_MailboxTrackingFolders |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_ProcessSession
Added by: System Solution Solution
Same as the maskingrule_ProcessSession many-to-one relationship for the processsession table/entity.
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_ProcessSession |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_BulkDeleteFailures
Added by: System Solution Solution
Same as the maskingrule_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_BulkDeleteFailures |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as the maskingrule_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_PrincipalObjectAttributeAccesses |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
maskingrule_attributemaskingrule
Same as the maskingrule_attributemaskingrule many-to-one relationship for the attributemaskingrule table/entity.
Property | Value |
---|---|
ReferencingEntity | attributemaskingrule |
ReferencingAttribute | maskingruleid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | maskingrule_attributemaskingrule |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.
organization_maskingrule
Added by: System Solution Solution
See the organization_maskingrule one-to-many relationship for the organization table/entity.
See also
Dataverse table/entity reference
Web API Reference
maskingrule EntityType
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for