Edit

Share via

Set-EntraBetaFeatureRolloutPolicy

Module:
Microsoft.Entra.Beta Module v1.1

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

Syntax

Default (Default) 

Set-EntraBetaFeatureRolloutPolicy

    [-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-EntraBetaFeatureRolloutPolicy 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'
$policy = Get-EntraBetaFeatureRolloutPolicy -Filter "DisplayName eq 'Feature-Rollout-Policy'"
Set-EntraBetaFeatureRolloutPolicy -Id $policy.Id -DisplayName 'Feature-Rollout-Policytest' -IsEnabled $false

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'
$policy = Get-EntraBetaFeatureRolloutPolicy -Filter "DisplayName eq 'Feature-Rollout-Policy'"
Set-EntraBetaFeatureRolloutPolicy -Id $policy.Id -Description 'Feature-Rollout-Policytest'

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'
$policy = Get-EntraBetaFeatureRolloutPolicy -Filter "DisplayName eq 'Feature-Rollout-Policy'"
Set-EntraBetaFeatureRolloutPolicy -Id $policy.Id -IsAppliedToOrganization $false

This command updates the -IsAppliedToOrganization parameter of policy for cloud authentication roll-out in Microsoft Entra ID to indicate that the feature should be applied to the entire organization.

  • -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.

Parameter properties

Type:

System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.MsDirectoryObject]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

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

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

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

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Feature

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

Possible values are:

  • passthroughAuthentication
  • seamlessSso
  • passwordHashSync
  • emailAsAlternateId
  • unknownFutureValue
  • certificateBasedAuthentication
  • multiFactorAuthentication

Parameter properties

Type:FeatureEnum
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

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

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-IsAppliedToOrganization

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

Parameter properties

Type:System.Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsEnabled

Specifies the status of cloud authentication roll-out policy.

Parameter properties

Type:System.Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

See more details - /graph/api/resources/featurerolloutpolicy