Agent Rule (AgentRule) table/entity reference (Microsoft Dataverse)

Agent Rule for event and schedule-based instruction activation

Messages

The following table lists the messages for the Agent Rule (AgentRule) 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
Assign Event: True	PATCH /agentrules(agentruleid) Update the ownerid property.	AssignRequest
Associate Event: True	Associate records	Associate records
Create Event: True	POST /agentrules See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /agentrules(agentruleid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
GrantAccess Event: True	GrantAccess	GrantAccessRequest
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
ModifyAccess Event: True	ModifyAccess	ModifyAccessRequest
Restore Event: True	Restore	Learn to use messages with the SDK for .NET
Retrieve Event: True	GET /agentrules(agentruleid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /agentrules See Query data	Query data
RetrievePrincipalAccess Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess Event: True	RevokeAccess	RevokeAccessRequest
SetState Event: True	PATCH /agentrules(agentruleid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /agentrules(agentruleid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /agentrules(agentruleid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest

Properties

The following table lists selected properties for the Agent Rule (AgentRule) table.

Property	Value
DisplayName	Agent Rule
DisplayCollectionName	Agent Rules
SchemaName	AgentRule
CollectionSchemaName	AgentRules
EntitySetName	agentrules
LogicalName	agentrule
LogicalCollectionName	agentrules
PrimaryIdAttribute	agentruleid
PrimaryNameAttribute	displayname
TableType	Standard
OwnershipType	UserOwned

Writable columns/attributes

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

• AgentRuleId
• AgentUserId
• Description
• DisplayName
• EventType
• ImportSequenceNumber
• Logic
• MCPPromptId
• Name
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• RuleDefinition
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

AgentRuleId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Agent Rule Id
IsValidForForm	False
IsValidForRead	True
LogicalName	agentruleid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

AgentUserId

Property	Value
Description	Object ID (OID) of the Entra agentic user that owns this rule
DisplayName	Agent User Id
IsValidForForm	True
IsValidForRead	True
LogicalName	agentuserid
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

Description

Property	Value
Description	Description of what this Agent Rule does
DisplayName	Description
IsValidForForm	True
IsValidForRead	True
LogicalName	description
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

DisplayName

Property	Value
Description	Display Name of the Agent Rule
DisplayName	Display Name
IsValidForForm	True
IsValidForRead	True
LogicalName	displayname
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

EventType

Property	Value
Description	Event type this rule applies to (email, document, message, schedule)
DisplayName	Event Type
IsValidForForm	True
IsValidForRead	True
LogicalName	eventtype
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	50

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	importsequencenumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

Logic

Property	Value
Description	Logical operator for conditions: all (AND) or any (OR)
DisplayName	Logic
IsValidForForm	True
IsValidForRead	True
LogicalName	logic
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	10

MCPPromptId

Property	Value
Description	Reference to MCPPrompt that contains the instruction for this rule
DisplayName	Instruction
IsValidForForm	True
IsValidForRead	True
LogicalName	mcppromptid
RequiredLevel	SystemRequired
Type	Lookup
Targets	mcpprompt

Name

Property	Value
Description	Name of the Agent Rule
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	name
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

OwnerId

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Type	Owner
Targets	systemuser, team

OwnerIdType

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

RuleDefinition

Property	Value
Description	JSON containing filter conditions and rules
DisplayName	Rule Definition
IsValidForForm	True
IsValidForRead	True
LogicalName	ruledefinition
RequiredLevel	SystemRequired
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	20000

statecode

Property	Value
Description	Status of the Agent Rule
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	agentrule_statecode

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: Active
1	Label: Inactive DefaultStatus: 2 InvariantName: Inactive

statuscode

Property	Value
Description	Reason for the status of the Agent Rule
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	agentrule_statuscode

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

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.

• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• VersionNumber

OwnerIdName

Property	Value
Description	Name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwnerIdYomiName

Property	Value
Description	Yomi name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwningBusinessUnit

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Type	Lookup
Targets	businessunit

OwningTeam

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Type	Lookup
Targets	team

OwningUser

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Type	Lookup
Targets	systemuser

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

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

• AgentRule_MCPPrompt_MCPPrompt
• business_unit_agentrule
• owner_agentrule
• team_agentrule
• user_agentrule

AgentRule_MCPPrompt_MCPPrompt

One-To-Many Relationship: mcpprompt AgentRule_MCPPrompt_MCPPrompt

Property	Value
ReferencedEntity	mcpprompt
ReferencedAttribute	mcppromptid
ReferencingAttribute	mcppromptid
ReferencingEntityNavigationPropertyName	MCPPrompt
IsHierarchical
CascadeConfiguration	Archive: RemoveLink Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

business_unit_agentrule

One-To-Many Relationship: businessunit business_unit_agentrule

Property	Value
ReferencedEntity	businessunit
ReferencedAttribute	businessunitid
ReferencingAttribute	owningbusinessunit
ReferencingEntityNavigationPropertyName	owningbusinessunit
IsHierarchical
CascadeConfiguration	Archive: Restrict Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

owner_agentrule

One-To-Many Relationship: owner owner_agentrule

Property	Value
ReferencedEntity	owner
ReferencedAttribute	ownerid
ReferencingAttribute	ownerid
ReferencingEntityNavigationPropertyName	ownerid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

team_agentrule

One-To-Many Relationship: team team_agentrule

Property	Value
ReferencedEntity	team
ReferencedAttribute	teamid
ReferencingAttribute	owningteam
ReferencingEntityNavigationPropertyName	owningteam
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

user_agentrule

One-To-Many Relationship: systemuser user_agentrule

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	owninguser
ReferencingEntityNavigationPropertyName	owninguser
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.

• agentrule_AsyncOperations
• agentrule_BulkDeleteFailures
• agentrule_DeletedItemReferences
• agentrule_MailboxTrackingFolders
• agentrule_PrincipalObjectAttributeAccesses
• agentrule_ProcessSession
• agentrule_SyncErrors

agentrule_AsyncOperations

Many-To-One Relationship: asyncoperation agentrule_AsyncOperations

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

agentrule_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure agentrule_BulkDeleteFailures

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

agentrule_DeletedItemReferences

Many-To-One Relationship: deleteditemreference agentrule_DeletedItemReferences

Property	Value
ReferencingEntity	deleteditemreference
ReferencingAttribute	deletedobject
ReferencedEntityNavigationPropertyName	agentrule_DeletedItemReferences
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

agentrule_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder agentrule_MailboxTrackingFolders

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

agentrule_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess agentrule_PrincipalObjectAttributeAccesses

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

agentrule_ProcessSession

Many-To-One Relationship: processsession agentrule_ProcessSession

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

agentrule_SyncErrors

Many-To-One Relationship: syncerror agentrule_SyncErrors

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

See also

Dataverse table/entity reference
Dataverse Web API Reference
agentrule