Get-EntraFeatureRolloutPolicy
Gets the policy for cloud authentication roll-out in Microsoft Entra ID.
Syntax
GetQuery (Default)
Get-EntraFeatureRolloutPolicy
[-Filter <String>]
[-Property <String[]>]
[<CommonParameters>]
GetVague
Get-EntraFeatureRolloutPolicy
[-SearchString <String>]
[<CommonParameters>]
GetById
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'
$policy = Get-EntraFeatureRolloutPolicy -Filter "DisplayName eq 'FeatureRolloutPolicy'"
Get-EntraFeatureRolloutPolicy -Id $policy.Id
Id Description DisplayName Feature IsAppliedToOrganization IsEnabled
-- ----------- ----------- ------- ----------------------- ---------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Feature-Rollout-Policy FeatureRolloutPolicy 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 FeatureRolloutPolicy 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 FeatureRolloutPolicy 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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetQuery
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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
GetById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Property
Specifies properties to be returned.
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Select |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SearchString
Specifies a search string.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetVague
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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.