Get-EntraBetaTrustFrameworkPolicy
Retrieves the created trust framework policies (custom policies) in the directory.
Syntax
GetQuery (Default)
Get-EntraBetaTrustFrameworkPolicy
[-Property <String[]>]
[<CommonParameters>]
GetById
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
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.
-IdParameter 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.
-IdParameter specifies ID for a trust framework policy.-OutputFilePathParameter 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.
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 |
-OutputFilePath
Path to the file used for retrieve the contents of trust framework policy.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetById
| Position: | Named |
| Mandatory: | False |
| 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 |
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.