Edit

Share via

Get-OrganizationSegment

Module:
Exchange PowerShell

This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.

Use the Get-OrganizationSegment cmdlet to view organization segments in the Microsoft Purview compliance portal.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

OrganizationSegmentsDefault (Default) 

Get-OrganizationSegment
    [<CommonParameters>]

Identity 

Get-OrganizationSegment
    [[-Identity] <PolicyIdParameter>]
    [<CommonParameters>]

Description

Segments are defined by using certain attributes in Microsoft Entra ID.

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-OrganizationSegment | Format-List Name,UserGroupFilter

This example returns a summary list of all organization segments.

Example 2

Get-OrganizationSegment -Identity "Engineering Group"

This example returns detailed information about the organization segment named Engineering Group.

Parameters

-Identity

Applicable: Security & Compliance

The Identity parameter specifies the organization segment that you want to view. You can use a value that uniquely identifies the segment. For example:

  • Name
  • Distinguished name (DN)
  • ExchangeObjectId (not the ExoSegmentId)

Parameter properties

Type:PolicyIdParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identity
Position:0
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.