Edit

Share via


Get-EntraExtensionProperty

Gets extension properties registered with Microsoft Entra ID.

Syntax

Default (Default)

Get-EntraExtensionProperty

    [-IsSyncedFromOnPremises <Boolean>]
    [-Name <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Get-EntraExtensionProperty cmdlet gets a collection that contains the extension properties registered with Microsoft Entra ID through Microsoft Entra ID Connect.

You can get extension properties that are synced with on-premises Microsoft Entra ID that aren't synced with on-premises Microsoft Entra ID or both types.

This command returns all directory extension definitions registered in a directory, including those from multitenant apps. The following entities support extension properties:

  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

Parameters

-IsSyncedFromOnPremises

Specifies whether this cmdlet gets extension properties that are synced or not synced.

  • $True - get extension properties that are synced from the on-premises Microsoft Entra ID.
  • $False - get extension properties that aren't synced from the on-premises Microsoft Entra ID.
  • No value - get all extension properties (both synced and nonsynced).

Parameter properties

Type:System.Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Filter using the extension name.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:Named
Mandatory:True
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.