Edit

Share via


Get-EntraDirSyncConfiguration

Gets the directory synchronization settings.

Syntax

Default (Default)

Get-EntraDirSyncConfiguration

    [-TenantId <String>]
    [<CommonParameters>]

Description

The Get-EntraDirSyncConfiguration cmdlet gets the directory synchronization settings. See configuration settings details.

For delegated scenarios, the user needs to be assigned the Global Administrator role.

Examples

Example 1: Get directory synchronization settings

Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All'
Get-EntraDirSyncConfiguration
AccidentalDeletionThreshold DeletionPreventionType
--------------------------- ----------------------
                        500 enabledForCount

This example gets directory synchronization settings.

Example 2: Get directory synchronization settings by TenantId

Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All'
$tenant = Get-EntraTenantDetail
Get-EntraDirSyncConfiguration -TenantId $tenant.Id
AccidentalDeletionThreshold DeletionPreventionType
--------------------------- ----------------------
                        500 enabledForCount

This example gets directory synchronization settings by TenantId.

  • -TenantId Specifies the unique ID of the tenant.

Parameters

-TenantId

The unique ID of the tenant for the operation. This parameter provides compatibility with Azure AD and MSOnline for partner scenarios. TenantID is the signed-in user's tenant ID.

Parameter properties

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

Parameter sets

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

Inputs

System.Nullable`1