Edit

Share via

Get-EntraBetaUserExtension

Module:
Microsoft.Entra.Beta Module v1.1

Gets a user extension.

Syntax

Default (Default) 

Get-EntraBetaUserExtension

    -UserId <String>
    [-Property <String[]>]
    [<CommonParameters>]

Description

The Get-EntraBetaUserExtension cmdlet gets a user extension in Microsoft Entra ID.

Examples

Example 1: Retrieve extension attributes for a user

Connect-Entra -Scopes 'User.Read'
Get-EntraBetaUserExtension -UserId 'SawyerM@contoso.com'

onPremisesDistinguishedName :
@odata.context              : https://graph.microsoft.com/beta/$metadata#users(identities,onPremisesDistinguishedName,employeeId,createdDateTime)/$entity
identities                  : {@{issuer=SawyerM@contoso.com; signInType=userPrincipalName; issuerAssignedId=SawyerM@contoso.com}}
employeeId                  :
id                          : 00aa00aa-bb11-cc22-dd33-44ee44ee44ee
createdDateTime             : 18/07/2024 05:13:40
userIdentities              : {@{issuer=SawyerM@contoso.com; signInType=userPrincipalName; issuerAssignedId=SawyerM@contoso.com}}

This example shows how to retrieve the extension attributes for a specified user.

  • -UserId parameter specifies the user object Id.

Parameters

-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

-UserId

Specifies the ID of a user's UserPrincipalName or UserId in Microsoft Entra ID.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ObjectId, UPN, Identity, UserPrincipalName

Parameter sets

(All)
Position:Named
Mandatory:True
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.