Get-EntraFeatureRolloutPolicy

Gets the policy for cloud authentication roll-out in Microsoft Entra ID.

Syntax

Get-EntraFeatureRolloutPolicy
   [-Filter <String>]
   [-Property <String[]>]
   [<CommonParameters>]
Get-EntraFeatureRolloutPolicy
   [-SearchString <String>]
   [<CommonParameters>]
Get-EntraFeatureRolloutPolicy
   -Id <String>
   [<CommonParameters>]

Description

The Get-EntraFeatureRolloutPolicy cmdlet allows an admin to get the policy for cloud authentication rollout (users moving from federation to cloud auth) in Microsoft Entra ID.

This policy consists of one or two FeatureRolloutPolicy objects. These objects hold the groups assigned for cloud authentication (Pass-through authentication or Password Hash Sync) and groups assigned for Seamless single sign-on.

Examples

Example 1: Retrieves a list of all cloud authentication roll-out in Microsoft Entra ID

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraFeatureRolloutPolicy

Id                                   Description            DisplayName                Feature            IsAppliedToOrganization IsEnabled
--                                   -----------            -----------                -------            ----------------------- ---------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Feature-Rollout-test   Feature-Rollout-Policytest passwordHashSync   False                   True
bbbbbbbb-1111-2222-3333-cccccccccccc Feature-Rollout-Policy change                     emailAsAlternateId False                   False

This command retrieves a list of all cloud authentication roll-out policies in Microsoft Entra ID.

Example 2: Retrieves cloud authentication roll-out in Microsoft Entra ID with given ID

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraFeatureRolloutPolicy -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'

Id                                   Description            DisplayName Feature            IsAppliedToOrganization IsEnabled
--                                   -----------            ----------- -------            ----------------------- ---------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb  Feature-Rollout-Policy change      emailAsAlternateId False                   False

This example retrieves the policy for cloud authentication roll-out policy in Microsoft Entra ID.

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

Example 3: Retrieves cloud authentication roll-out in Microsoft Entra ID with given Search String

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraFeatureRolloutPolicy -SearchString 'Feature-Rollout-Policy'

Id                                   Description            DisplayName Feature            IsAppliedToOrganization IsEnabled
--                                   -----------            ----------- -------            ----------------------- ---------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb  Feature-Rollout-Policy change      emailAsAlternateId False                   False

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

Example 4: Retrieves cloud authentication roll-out in Microsoft Entra ID with given Filter parameter

Connect-Entra -Scopes 'Directory.ReadWrite.All'
Get-EntraFeatureRolloutPolicy -Filter "Description eq 'Feature-Rollout-Policy'"

Id                                   Description            DisplayName Feature            IsAppliedToOrganization IsEnabled
--                                   -----------            ----------- -------            ----------------------- ---------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb  Feature-Rollout-Policy change      emailAsAlternateId False                   False

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

Parameters

-Filter

Specifies an OData v4.0 filter statement. Controls which objects are returned.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

-Property

Specifies properties to be returned.

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

-SearchString

Specifies a search string.

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

Outputs

Microsoft.Online.Administration.MsFeatureRolloutPolicy