conditionalAccessPolicyRule resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a rule in a Conditional Access policy plan. The rule defines scenario-specific conditions and enforcement controls that are combined with the parent plan's shared conditions during evaluation.

Inherits from entity

Methods

Method	Return type	Description
List	conditionalAccessPolicyRule collection	Retrieve the rules in a Conditional Access policy plan.
Create	conditionalAccessPolicyRule	Create a rule in a Conditional Access policy plan.
Get	conditionalAccessPolicyRule	Retrieve a rule in a Conditional Access policy plan.
Update	conditionalAccessPolicyRule	Update a rule in a Conditional Access policy plan.
Delete	None	Delete a rule from a Conditional Access policy plan.

Properties

Property	Type	Description
conditions	conditionalAccessConditionSet	The conditions specific to the rule. During evaluation, these conditions are combined with the parent plan's sharedConditions property to determine the rule's effective targeting.
controls	conditionalAccessPolicyRuleControls	The grant and session controls enforced when the rule's effective conditions are met.
description	String	A free-text description of the rule's purpose.
displayName	String	The administrator-defined display name for the rule.
id	String	The unique identifier for the rule. Read-only. Inherits from entity.
state	conditionalAccessPolicyState	The state of the rule. The possible values are: enabled, disabled, enabledForReportingButNotEnforced.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.conditionalAccessPolicyRule",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "state": "String",
  "conditions": {
    "@odata.type": "microsoft.graph.conditionalAccessConditionSet"
  },
  "controls": {
    "@odata.type": "microsoft.graph.conditionalAccessPolicyRuleControls"
  }
}