Edit

Share via

Set-EntraFeatureRolloutPolicy

  • Reference
Module:
Microsoft.Graph.Entra

Allows an admin to modify the policy for cloud authentication roll-out in Microsoft Entra ID.

Syntax

Set-EntraFeatureRolloutPolicy
   [-Feature <FeatureEnum>]
   [-IsEnabled <Boolean>]
   -Id <String>
   [-IsAppliedToOrganization <Boolean>]
   [-AppliesTo <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.MsDirectoryObject]>]
   [-Description <String>]
   [-DisplayName <String>]
   [<CommonParameters>]

Description

An admin uses the Set-EntraFeatureRolloutPolicy cmdlet to modify the cloud authentication rollout policy.

This includes specifying whether the method for cloud authentication is Pass-through Authentication or Password Hash Synchronization, and whether Seamless Single Sign-On (SSO) is enabled.

Users in groups assigned to the policy will start authenticating using the new method and Seamless SSO, if it is specified.

Examples

Example 1: Updates the policy for cloud authentication roll-out in Microsoft Entra ID

Connect-Entra -Scopes 'Directory.ReadWrite.All'
$params = @{
    Id = 'bbbbbbbb-1111-2222-3333-cccccccccccc'
    DisplayName = 'Feature-Rollout-Policytest' 
    IsEnabled = $false
}
Set-EntraFeatureRolloutPolicy  @params

This command updates the policy for cloud authentication roll-out in Microsoft Entra ID.

  • -Id - specifies the ID of cloud authentication roll-out policy.
  • -DisplayName - specifies the display name of the cloud authentication roll-out policy.
  • -IsEnabled - specifies the status of cloud authentication roll-out policy.

Example 2: Updates the Description

Connect-Entra -Scopes 'Directory.ReadWrite.All'
$params = @{
    Id = 'bbbbbbbb-1111-2222-3333-cccccccccccc'
    Description = 'Feature-Rollout-test'
}
Set-EntraFeatureRolloutPolicy  @params

This command updates the -Description of policy for cloud authentication roll-out in Microsoft Entra ID.

  • -Id Specify the ID of cloud authentication roll-out policy.
  • -Description Specifies the description of the cloud authentication roll-out policy.

Example 3: Updates the IsAppliedToOrganization

Connect-Entra -Scopes 'Directory.ReadWrite.All'
$params = @{
    Id = 'bbbbbbbb-1111-2222-3333-cccccccccccc'
    IsAppliedToOrganization = $false
}
Set-EntraFeatureRolloutPolicy  @params

This command updates the -IsAppliedToOrganization parameter of policy for cloud authentication roll-out in Microsoft Entra ID.

  • -Id Specify the ID of cloud authentication roll-out policy.
  • -IsAppliedToOrganization Parameter determines whether a particular feature rollout policy should be applied to the entire organization or not.

Parameters

-AppliesTo

Specifies a list of Microsoft Entra ID objects that is assigned to the feature.

Type:System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.MsDirectoryObject]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies the description of the cloud authentication roll-out policy.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

Specifies the display name of the cloud authentication roll-out policy.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Feature

Specifies a feature assigned to the cloud authentication roll-out policy.

Currently, you can assign PassthroughAuthentication | SeamlessSso | PasswordHashSync | EmailAsAlternateId.

Type:FeatureEnum
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

The unique identifier of the cloud authentication roll-out policy in Microsoft Entra ID.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IsAppliedToOrganization

Specifies if the cloud authentication roll-out policy applied to the entire organization.

Type:System.Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsEnabled

Specifies the status of cloud authentication roll-out policy.

Type:System.Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False