Get-InformationBarrierRecipientStatus
This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.
Use the Get-InformationBarrierRecipientStatus cmdlet to return information about recipients and their relationship to information barrier policies.
Note: This cmdlet doesn't work with information barriers in non-legacy mode. To determine your current mode, see Check the IB mode for your organization. If you're in non-legacy mode, run the following command to get information about a single recipient: Get-Recipient -Identity <IdentityValue> | Format-List Name,*segment*
. Similarly, to get the relationship information between two recipients, use the Get-ExoInformationBarrierRelationship cmdlet.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Get-InformationBarrierRecipientStatus
[-Identity] <RecipientIdParameter>
[[-Identity2] <RecipientIdParameter>]
[<CommonParameters>]
Description
The following information is returned in the output of this cmdlet:
- A warning message that indicates whether or not the recipient is included in an information barrier policy.
- If present, the GUID part in the ExOPolicyId property value identifies the information barrier policy that the recipient is included in. You can run the command
Get-InformationBarrierPolicy -ExOPolicyId <GUID>
to identify and view the details of the policy. - Basic information about the recipient (display name, alias, and last name).
- Recipient properties that can be used in organization segments (Department, CustomAttributeN, etc.) and the current property values for the recipient.
To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in the Microsoft Purview compliance portal.
Examples
Example 1
Get-InformationBarrierRecipientStatus -Identity meganb
This example returns the information barrier policy information for the user meganb.
Example 2
Get-InformationBarrierRecipientStatus -Identity meganb -Identity2 alexw
This example returns the information barrier policy relationship for the users meganb and alexw.
Parameters
-Identity
The Identity parameter specifies the recipient that you want to view the segment and policy assignment information for. You can use any value that uniquely identifies the recipient. For example:
- Name
- Alias
- Distinguished name (DN)
- Canonical DN
- Email address
- GUID
Type: | RecipientIdParameter |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Identity2
The Identity2 parameter specifies an optional second recipient when you want to view the information barrier policy relationship to the first recipient specified by the Identity parameter. You can use any value that uniquely identifies the second recipient. For example:
- Name
- Alias
- Distinguished name (DN)
- Canonical DN
- Email address
- GUID
When you include this parameter in a command, you get output for each recipient.
You can only use this parameter with the Identity parameter; you can't use it by itself.
Type: | RecipientIdParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |