featureRolloutPolicy resource type

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

Represents a feature rollout policy associated with a directory object. Creating a feature rollout policy helps tenant administrators to pilot features of Azure AD with a specific group before enabling features for entire organization. This minimizes the impact and helps administrators to test and rollout authentication related features gradually.

The following are limitations of feature rollout:

  • Each feature supports a maximum of 10 groups.
  • The appliesTo field only supports groups.
  • Dynamic groups and nested groups are not supported.

The following are pre-requisites for each of the features that are currently suported for rollout using this rollout policy.

Passthrough Authentication

  • Identify a server running Windows Server 2012 R2 or later where you want the PassthroughAuthentication Agent to run. Ensure that the server is domain-joined, can authenticate selected users with Active Directory, and can communicate with Azure AD on outbound ports / URLs.
  • Download & install the Microsoft Azure AD Connect Authentication Agent on the server.
  • To enable high availability, install additional Authentication Agents on other servers as described here.
  • Ensure that you have configured your Smart Lockout settings appropriately. This is to ensure that your users’ on-premises Active Directory accounts don’t get locked out by bad actors.

SeamlessSso

PasswordHashSync

  • Enable PasswordHashSync from the “Optional features” page in Azure AD Connect.

Methods

Method Return Type Description
List featureRolloutPolicies featureRolloutPolicy Retrieve a list of featureRolloutPolicy objects.
Get featureRolloutPolicy featureRolloutPolicy Retrieve the properties and relationships of featurerolloutpolicy object.
Create featureRolloutPolicy featureRolloutPolicy Create a new featureRolloutPolicy object.
Update featureRolloutPolicy featureRolloutPolicy Update the properties of featurerolloutpolicy object.
Delete featureRolloutPolicy None Delete a featureRolloutPolicy object.
Assign appliesTo directoryObject Assign a directoryObject to feature rollout.
Remove appliesTo None Remove a directoryObject from feature rollout.

Properties

Property Type Description
description String A description for this feature rollout policy.
displayName String The display name for this feature rollout policy.
feature stagedFeatureName Possible values are: passthroughAuthentication, seamlessSso, passwordHashSync, unknownFutureValue.
id String Read-only.
isAppliedToOrganization Boolean Indicates whether this feature rollout policy should be applied to the entire organization.
isEnabled Boolean Indicates whether the feature rollout is enabled.

Relationships

Relationship Type Description
appliesTo directoryObject collection Nullable. Specifies a list of directoryObjects that feature is enabled for.

JSON representation

The following is a JSON representation of the resource.

{
  "description": "String",
  "displayName": "String",
  "feature": "string",
  "id": "String (identifier)",
  "isAppliedToOrganization": false,
  "isEnabled": true
}