Edit

Share via

Get-EntraBetaTrustFrameworkPolicy

  • Reference
Module:
Microsoft.Entra.Beta

Retrieves the created trust framework policies (custom policies) in the directory.

Syntax

Get-EntraBetaTrustFrameworkPolicy
   [-Property <String[]>]
   [<CommonParameters>]
Get-EntraBetaTrustFrameworkPolicy
   -Id <String>
   [-OutputFilePath <String>]
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraBetaTrustFrameworkPolicy cmdlet retrieves the trust framework policies that have been created in the directory.

In delegated scenarios with work or school accounts, the admin must have a supported Microsoft Entra role or a custom role with the required permissions. The B2C IEF Policy Administrator is the least privileged role that supports this operation.

Examples

Example 1: Retrieves the list of all trust framework policies in the directory

Connect-Entra -Scopes 'Policy.Read.All', 'Policy.ReadWrite.TrustFramework'
Get-EntraBetaTrustFrameworkPolicy

Id                                                                                                               ---                                              B2C_1A_SIGNUP_SIGNIN                                                                                             B2C_1A_TRUSTFRAMEWORKBASE
B2C_1A_TRUSTFRAMEWORKEXTENSIONS

This example retrieves the list of all trust framework policies in the directory.

Example 2: Retrieves the contents of the specified trust framework policy

Connect-Entra -Scopes 'Policy.Read.All', 'Policy.ReadWrite.TrustFramework'
$params = @{
    Id = 'B2C_1A_SIGNUP_SIGNIN'
}
Get-EntraBetaTrustFrameworkPolicy @params

This example retrieves the contents of the specified trust framework policy.

The contents of received trust framework policy are displayed on screen.

  • -Id Parameter specifies ID for a trust framework policy.

Example 3: Retrieves the contents of the specified trust framework policy on specific output file path

Connect-Entra -Scopes 'Policy.Read.All', 'Policy.ReadWrite.TrustFramework'
$params = @{
    Id = 'B2C_1A_SIGNUP_SIGNIN'
    OutputFilePath = 'C:\RetrivedPolicy.xml'
}
Get-EntraBetaTrustFrameworkPolicy @params

This example retrieves the contents of the specified trust framework policy on specific output file path.

  • -Id Parameter specifies ID for a trust framework policy.
  • -OutputFilePath Parameter specifies the path to the file used for retrieve the contents of trust framework policy.

Parameters

-Id

The unique identifier for a trust framework policy.

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

-OutputFilePath

Path to the file used for retrieve the contents of trust framework policy.

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

-Property

Specifies properties to be returned.

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

Inputs

System.String

Outputs

System.Object