Get-EntraBetaPolicy

Module:

Microsoft.Entra.Beta.SignIns Module v1.3

Gets a policy.

Get-EntraBetaPolicy

 [-Top <Int32>]
 [-All]
 [<CommonParameters>]

Get-EntraBetaPolicy

 -Id <String>
 [-All]
 [<CommonParameters>]

The Get-EntraBetaPolicy cmdlet gets a policy in Microsoft Entra ID. Specify Id parameter to get a specific policy.

Connect-Entra -Scopes 'Policy.Read.All'
Get-EntraBetaPolicy

Definition DeletedDateTime Description DisplayName Id
---------- --------------- ----------- ----------- --
{{"activityBasedTimeoutPolicies":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}} Activepolicy bbbbbbbb-1111-2222-3333-cccccccccccc
{{"HomeRealmDiscoveryPolicy":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}} PolicyDemo aaaaaaaa-1111-1111-1111-000000000000

This example shows how to return all policies.

Connect-Entra -Scopes 'Policy.Read.All'
Get-EntraBetaPolicy | Where-Object {$_.DisplayName -eq 'Microsoft User Default Recommended Policy'}

DeletedDateTime Description DisplayName Id
--------------- ----------- ----------- --
 Permissions consentable based on Microsoft's current recommendations. Microsoft User Default Recommended Policy microsoft-user-default-recommended

This example shows how to get a specific policy using Display Name.

Connect-Entra -Scopes 'Policy.Read.All'
$policy = Get-EntraBetaPolicy | Where-Object {$_.DisplayName -eq 'Microsoft User Default Recommended Policy'}
Get-EntraBetaPolicy -Id $policy.Id

Id Description DisplayName Feature IsAppliedToOrganization IsEnabled
-- ----------- ----------- ------- ----------------------- ---------
bbbbbbbb-1111-2222-3333-cccccccccccc passwordHashSync rollout policy passwordHashSync rollout policy passwordHashSync False True

This example demonstrated how to receive policy with specific ID.

• Id parameter specifies the unique policy ID, which you want to receive. In this example, bbbbbbbb-1111-2222-3333-cccccccccccc represents the ID of the policy.

Connect-Entra -Scopes 'Policy.Read.All'
Get-EntraBetaPolicy -All

Definition DeletedDateTime Description DisplayName Id
---------- --------------- ----------- ----------- --
{{"activityBasedTimeoutPolicies":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}} Activepolicy bbbbbbbb-1111-2222-3333-cccccccccccc
{{"HomeRealmDiscoveryPolicy":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}} PolicyDemo aaaaaaaa-1111-1111-1111-000000000000

This example demonstrates how to retrieve all policies in Microsoft Entra ID.

Connect-Entra -Scopes 'Policy.Read.All'
Get-EntraBetaPolicy -Top 1

Id Description DisplayName Feature IsAppliedToOrganization IsEnabled
-- ----------- ----------- ------- ----------------------- ---------
bbbbbbbb-1111-2222-3333-cccccccccccc passwordHashSync rollout policy passwordHashSync rollout policy passwordHashSync False True

This example demonstrates how to retrieve top one policies in Microsoft Entra ID. You can use -Limit as an alias for -Top.

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.