Microsoft Entra Connect：ADSync PowerShell 参考

项目
2024/06/19

以下文档提供了 Microsoft Entra Connect 附带的 ADSync.psm1 PowerShell 模块的参考信息。

Add-ADSyncADDSConnectorAccount

摘要

此 cmdlet 重置服务帐户的密码，并在 Microsoft Entra ID 和同步引擎中更新该密码。

SYNTAX

byIdentifier

   Add-ADSyncADDSConnectorAccount [-Identifier] <Guid> [-EACredential <PSCredential>] [<CommonParameters>]

byName

    Add-ADSyncADDSConnectorAccount [-Name] <String> [-EACredential <PSCredential>] [<CommonParameters>]

DESCRIPTION

此 cmdlet 重置服务帐户的密码，并在 Microsoft Entra ID 和同步引擎中更新该密码。

示例

示例 1

  PS C:\> Add-ADSyncADDSConnectorAccount -Name contoso.com -EACredential $EAcredentials

重置连接到 contoso.com 的服务帐户的密码。

PARAMETERS

-EACredential

Active Directory 中企业管理员帐户的凭据。

  Type: PSCredential
  Parameter Sets: (All)
  Aliases:

  Required: False
  Position: Named
  Default value: None
  Accept pipeline input: False
  Accept wildcard characters: False

-Identifier

需要重置其服务帐户密码的连接器的标识符。

  Type: Guid
  Parameter Sets: byIdentifier
  Aliases:

  Required: True
  Position: 0
  Default value: None
  Accept pipeline input: True (ByValue)
  Accept wildcard characters: False

-Name

连接器的名称。

  Type: String
  Parameter Sets: byName
  Aliases:

  Required: True
  Position: 1
  Default value: None
  Accept pipeline input: True (ByValue)
  Accept wildcard characters: False

CommonParameters

此 cmdlet 支持以下常见参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutVariable、-OutBuffer、-PipelineVariable、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。

输入

System.Guid

System.String

输出

System.Object

Disable-ADSyncExportDeletionThreshold

摘要

禁用导出阶段的删除阈值功能。

SYNTAX

   Disable-ADSyncExportDeletionThreshold [[-AADCredential] <PSCredential>] [-WhatIf] [-Confirm]
    [<CommonParameters>]

DESCRIPTION

禁用导出阶段的删除阈值功能。

示例

示例 1

    PS C:\> Disable-ADSyncExportDeletionThreshold -AADCredential $aadCreds

使用提供的 Microsoft Entra 凭据禁用导出删除阈值功能。

PARAMETERS

-AADCredential

Microsoft Entra 凭据。

   Type: PSCredential
   Parameter Sets: (All)
   Aliases:

   Required: False
   Position: 1
   Default value: None
   Accept pipeline input: True (ByPropertyName)
   Accept wildcard characters: False

-Confirm

用于提示确认的参数开关。

    Type: SwitchParameter
    Parameter Sets: (All)
    Aliases: cf

    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

    Type: SwitchParameter
    Parameter Sets: (All)
    Aliases: wi

    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False

CommonParameters

输入

System.Management.Automation.PSCredential

输出

System.Object

Enable-ADSyncExportDeletionThreshold

摘要

启用导出删除阈值功能并设置阈值。

SYNTAX

Enable-ADSyncExportDeletionThreshold [-DeletionThreshold] <UInt32> [[-AADCredential] <PSCredential>] [-WhatIf]
[-Confirm] [<CommonParameters>]

DESCRIPTION

启用导出删除阈值功能并设置阈值。

示例

示例 1

PS C:\> Enable-ADSyncExportDeletionThreshold -DeletionThreshold 777 -AADCredential $aadCreds

启用导出删除阈值功能并将删除阈值设置为 777。

PARAMETERS

-AADCredential

Microsoft Entra 凭据。

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeletionThreshold

删除阈值。

Type: UInt32
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

System.UInt32

System.Management.Automation.PSCredential

输出

System.Object

Get-ADSyncAutoUpgrade

摘要

获取安装的 AutoUpgrade 的状态。

SYNTAX

Get-ADSyncAutoUpgrade [-Detail] [<CommonParameters>]

DESCRIPTION

获取安装的 AutoUpgrade 的状态。

示例

示例 1

PS C:\> Get-ADSyncAutoUpgrade -Detail

返回安装的 AutoUpgrade 状态并在 AutoUpgrade 暂停时显示暂停原因。

PARAMETERS

-Detail

如果 AutoUpgrade 状态为暂停，则使用此参数显示暂停原因。

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Get-ADSyncCSObject

摘要

获取指定的连接器空间对象。

SYNTAX

SearchByIdentifier

Get-ADSyncCSObject [-Identifier] <Guid> [<CommonParameters>]

SearchByConnectorIdentifierDistinguishedName

Get-ADSyncCSObject [-ConnectorIdentifier] <Guid> [-DistinguishedName] <String> [-SkipDNValidation] [-Transient]
[<CommonParameters>]

SearchByConnectorIdentifier

Get-ADSyncCSObject [-ConnectorIdentifier] <Guid> [-Transient] [-StartIndex <Int32>] [-MaxResultCount <Int32>]
[<CommonParameters>]

SearchByConnectorNameDistinguishedName

Get-ADSyncCSObject [-ConnectorName] <String> [-DistinguishedName] <String> [-SkipDNValidation] [-Transient]
[<CommonParameters>]

SearchByConnectorName

Get-ADSyncCSObject [-ConnectorName] <String> [-Transient] [-StartIndex <Int32>] [-MaxResultCount <Int32>]
[<CommonParameters>]

DESCRIPTION

获取指定的连接器空间对象。

示例

示例 1

PS C:\> Get-ADSyncCSObject -ConnectorName "contoso.com" -DistinguishedName "CN=fabrikam,CN=Users,DC=contoso,DC=com"

获取 contoso.com 域中用户 fabrikam 的 CS 对象。

PARAMETERS

-ConnectorIdentifier

连接的标识符。

Type: Guid
Parameter Sets: SearchByConnectorIdentifierDistinguishedName, SearchByConnectorIdentifier 
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConnectorName

连接器的名称。

Type: String
Parameter Sets: SearchByConnectorNameDistinguishedName, SearchByConnectorName
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DistinguishedName

连接器空间对象的可分辨名称。

Type: String
Parameter Sets: SearchByConnectorIdentifierDistinguishedName, SearchByConnectorNameDistinguishedName
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identifier

连接器空间对象的标识符。

Type: Guid
Parameter Sets: SearchByIdentifier
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MaxResultCount

结果集的最大计数。

Type: Int32
Parameter Sets: SearchByConnectorIdentifier, SearchByConnectorName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SkipDNValidation

参数开关，用于跳过 DN 验证。

Type: SwitchParameter
Parameter Sets: SearchByConnectorIdentifierDistinguishedName, SearchByConnectorNameDistinguishedName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StartIndex

要从其返回计数的起始索引。

Type: Int32
Parameter Sets: SearchByConnectorIdentifier, SearchByConnectorName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Transient

参数开关，用于获取瞬时 CS 对象。

Type: SwitchParameter
Parameter Sets: SearchByConnectorIdentifierDistinguishedName, SearchByConnectorIdentifier, SearchByConnectorNameDistinguishedName, SearchByConnectorName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Get-ADSyncCSObjectLog

摘要

获取连接器空间对象日志条目。

SYNTAX

Get-ADSyncCSObjectLog [-Identifier] <Guid> [-Count] <UInt32> [<CommonParameters>]

DESCRIPTION

获取连接器空间对象日志条目。

示例

示例 1

PS C:\> Get-ADSyncCSObjectLog -Identifier "00000000-0000-0000-0000-000000000000" -Count 1

返回一个具有指定标识符的对象。

PARAMETERS

-Count

要检索的连接器空间对象日志条目的预期最大数量。

Type: UInt32
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identifier

连接器空间对象标识符。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Get-ADSyncDatabaseConfiguration

摘要

获取 ADSync 数据库的配置。

SYNTAX

Get-ADSyncDatabaseConfiguration [<CommonParameters>]

DESCRIPTION

获取 ADSync 数据库的配置。

示例

示例 1

PS C:\> Get-ADSyncDatabaseConfiguration

获取 ADSync 数据库的配置。

PARAMETERS

CommonParameters

输入

无

输出

System.Object

Get-ADSyncExportDeletionThreshold

摘要

从 Microsoft Entra ID 获取导出删除阈值。

SYNTAX

Get-ADSyncExportDeletionThreshold [[-AADCredential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

从 Microsoft Entra ID 获取导出删除阈值。

示例

示例 1

PS C:\> Get-ADSyncExportDeletionThreshold -AADCredential $aadCreds

使用指定的 Microsoft Entra 凭据从 Microsoft Entra ID 获取导出删除阈值。

PARAMETERS

-AADCredential

Microsoft Entra 凭据。

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

System.Management.Automation.PSCredential

输出

System.Object

Get-ADSyncMVObject

摘要

获取 metaverse 对象。

SYNTAX

Get-ADSyncMVObject -Identifier <Guid> [<CommonParameters>]

DESCRIPTION

获取 metaverse 对象。

示例

示例 1

PS C:\> Get-ADSyncMVObject -Identifier "00000000-0000-0000-0000-000000000000"

获取具有指定标识符的 metaverse 对象。

PARAMETERS

-Identifier

metaverse 对象的标识符。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Get-ADSyncRunProfileResult

摘要

处理来自客户端的输入并检索运行配置文件结果。

SYNTAX

Get-ADSyncRunProfileResult [-RunHistoryId <Guid>] [-ConnectorId <Guid>] [-RunProfileId <Guid>]
[-RunNumber <Int32>] [-NumberRequested <Int32>] [-RunStepDetails] [-StepNumber <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]

DESCRIPTION

处理来自客户端的输入并检索运行配置文件结果。

示例

示例 1

PS C:\> Get-ADSyncRunProfileResult -ConnectorId "00000000-0000-0000-0000-000000000000"

检索指定连接器的所有同步运行配置文件结果。

PARAMETERS

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConnectorId

连接器标识符。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NumberRequested

返回的最大数。

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RunHistoryId

特定运行的标识符。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RunNumber

特定运行的运行编号。

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RunProfileId

特定运行的运行配置文件标识符。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RunStepDetails

运行步骤详细信息的参数开关。

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StepNumber

按步骤编号进行筛选。

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Get-ADSyncRunStepResult

摘要

获取 AD Sync 运行步骤结果。

SYNTAX

Get-ADSyncRunStepResult [-RunHistoryId <Guid>] [-StepHistoryId <Guid>] [-First] [-StepNumber <Int32>] [-WhatIf]
[-Confirm] [<CommonParameters>]

DESCRIPTION

获取 AD Sync 运行步骤结果。

示例

示例 1

PS C:\> Get-ADSyncRunStepResult -RunHistoryId "00000000-0000-0000-0000-000000000000"

获取指定运行的 AD Sync 运行步骤结果。

PARAMETERS

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-First

仅获取第一个对象的参数开关。

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RunHistoryId

特定运行的 ID。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StepHistoryId

特定运行步骤的 ID。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StepNumber

步骤编号。

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Get-ADSyncScheduler

摘要

获取同步计划程序的当前同步周期设置。

SYNTAX

Get-ADSyncScheduler [<CommonParameters>]

DESCRIPTION

获取同步计划程序的当前同步周期设置。

示例

示例 1

PS C:\> Get-ADSyncScheduler

获取同步计划程序的当前同步周期设置。

PARAMETERS

CommonParameters

输入

无

输出

System.Object

Get-ADSyncSchedulerConnectorOverride

摘要

获取指定连接器的 AD 同步计划程序替代值。

SYNTAX

Get-ADSyncSchedulerConnectorOverride [-ConnectorIdentifier <Guid>] [-ConnectorName <String>]
[<CommonParameters>]

DESCRIPTION

获取指定连接器的 AD 同步计划程序替代值。

示例

示例 1

PS C:\> Get-ADSyncSchedulerConnectorOverride -ConnectorName "contoso.com"

获取“contoso.com”连接器的 AD 同步计划程序替代值。

示例 2

PS C:\> Get-ADSyncSchedulerConnectorOverride

获取所有 AD 同步计划程序替代值。

PARAMETERS

-ConnectorIdentifier

连接器标识符。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConnectorName

连接器名称。

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Invoke-ADSyncCSObjectPasswordHashSync

摘要

同步给定 AD 连接器空间对象的密码哈希。

SYNTAX

SearchByDistinguishedName

Invoke-ADSyncCSObjectPasswordHashSync [-ConnectorName] <String> [-DistinguishedName] <String>
[<CommonParameters>]

SearchByIdentifier

Invoke-ADSyncCSObjectPasswordHashSync [-Identifier] <Guid> [<CommonParameters>]

CSObject

Invoke-ADSyncCSObjectPasswordHashSync [-CsObject] <CsObject> [<CommonParameters>]

DESCRIPTION

同步给定 AD 连接器空间对象的密码哈希。

示例

示例 1

PS C:\> Invoke-ADSyncCSObjectPasswordHashSync -ConnectorName "contoso.com" -DistinguishedName "CN=fabrikam,CN=Users,DN=contoso,DN=com"

同步指定对象的密码哈希。

PARAMETERS

-ConnectorName

连接器的名称。

Type: String
Parameter Sets: SearchByDistinguishedName
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CsObject

连接器空间对象。

Type: CsObject
Parameter Sets: CSObject
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DistinguishedName

连接器空间对象的可分辨名称。

Type: String
Parameter Sets: SearchByDistinguishedName
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identifier

连接器空间对象的标识符。

Type: Guid
Parameter Sets: SearchByIdentifier
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Invoke-ADSyncRunProfile

摘要

调用特定的运行配置文件。

SYNTAX

ConnectorName

Invoke-ADSyncRunProfile -ConnectorName <String> -RunProfileName <String> [-Resume] [<CommonParameters>]

ConnectorIdentifier

Invoke-ADSyncRunProfile -ConnectorIdentifier <Guid> -RunProfileName <String> [-Resume] [<CommonParameters>]

DESCRIPTION

调用特定的运行配置文件。

示例

示例 1

PS C:\> Invoke-ADSyncRunProfile -ConnectorName "contoso.com" -RunProfileName Export

调用“contoso.com”连接器上的导出。

PARAMETERS

-ConnectorIdentifier

连接器的标识符。

Type: Guid
Parameter Sets: ConnectorIdentifier
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ConnectorName

连接器的名称。

Type: String
Parameter Sets: ConnectorName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Resume

参数开关，用于尝试恢复先前停滞/完成了一半的 RunProfile。

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RunProfileName

要在所选连接器上调用的运行配置文件的名称。

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

输入

System.String

System.Guid

输出

System.Object

Remove-ADSyncAADServiceAccount

摘要

删除（与指定凭据关联的）Microsoft Entra 租户的所有现有 Microsoft Entra 服务帐户。

SYNTAX

ServiceAccount

Remove-ADSyncAADServiceAccount [-AADCredential] <PSCredential> [-Name] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]

服务主体

Remove-ADSyncAADServiceAccount [-ServicePrincipal] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

删除（与指定凭据关联的）Microsoft Entra 租户的所有现有 Microsoft Entra 服务帐户。

示例

示例 1

PS C:\> Remove-ADSyncAADServiceAccount -AADCredential $aadcreds -Name contoso.com

删除 contoso.com 中的所有现有 Microsoft Entra 服务帐户。

PARAMETERS

-AADCredential

Microsoft Entra 凭据。

Type: PSCredential
Parameter Sets: ServiceAccount
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

帐户的名称。

Type: String
Parameter Sets: ServiceAccount
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServicePrincipal

帐户的服务主体。

Type: SwitchParameter
Parameter Sets: ServicePrincipal
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

System.Management.Automation.PSCredential

System.String

System.Management.Automation.SwitchParameter

输出

System.Object

Set-ADSyncAutoUpgrade

摘要

在“启用”和“禁用”之间更改安装上的 AutoUpgrade 状态。

SYNTAX

Set-ADSyncAutoUpgrade [-AutoUpgradeState] <AutoUpgradeConfigurationState> [[-SuspensionReason] <String>]
[<CommonParameters>]

DESCRIPTION

设置安装上的 AutoUpgrade 状态。此 cmdlet 应仅用于在“启用”和“禁用”之间更改 AutoUpgrade 状态。只有系统才能将状态设置为“暂停”。

示例

示例 1

PS C:\> Set-ADSyncAutoUpgrade -AutoUpgradeState Enabled

将 AutoUpgrade 状态设置为“启用”。

PARAMETERS

-AutoUpgradeState

AutoUpgrade 状态。接受的值：“暂停”、“启用”、“禁用”。

Type: AutoUpgradeConfigurationState
Parameter Sets: (All)
Aliases:
Accepted values: Suspended, Enabled, Disabled

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SuspensionReason

暂停原因。只有系统才能将 AutoUpgrade 的状态设置为“暂停”。

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Set-ADSyncScheduler

摘要

设置同步计划程序的当前同步周期设置。

SYNTAX

Set-ADSyncScheduler [[-CustomizedSyncCycleInterval] <TimeSpan>] [[-SyncCycleEnabled] <Boolean>]
[[-NextSyncCyclePolicyType] <SynchronizationPolicyType>] [[-PurgeRunHistoryInterval] <TimeSpan>]
[[-MaintenanceEnabled] <Boolean>] [[-SchedulerSuspended] <Boolean>] [-Force] [<CommonParameters>]

DESCRIPTION

设置同步计划程序的当前同步周期设置。

示例

示例 1

PS C:\> Set-ADSyncScheduler -SyncCycleEnabled $true

将 SyncCycleEnabled 的当前同步周期设置设置为 True。

PARAMETERS

-CustomizedSyncCycleInterval

请为要设置的自定义同步间隔指定时间跨度值。如果要在允许的最低设置上运行，请将此参数设置为 null。

Type: TimeSpan
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

用于强制设置值的参数开关。

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-MaintenanceEnabled

用于设置 MaintenanceEnabled 的参数。

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-NextSyncCyclePolicyType

用于设置 NextSyncCyclePolicyType 的参数。接受的值：“未指定”、“Delta”、“初始值”。

Type: SynchronizationPolicyType
Parameter Sets: (All)
Aliases:
Accepted values: Unspecified, Delta, Initial

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PurgeRunHistoryInterval

用于设置 PurgeRunHistoryInterval 的参数。

Type: TimeSpan
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SchedulerSuspended

用于设置 SchedulerSuspended 的参数。

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SyncCycleEnabled

用于设置 SyncCycleEnabled 的参数。

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

输入

System.Nullable`1[[System.TimeSpan, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

System.Nullable`1[[Microsoft.IdentityManagement.PowerShell.ObjectModel.SynchronizationPolicyType, Microsoft.IdentityManagement.PowerShell.ObjectModel, Version=1.4.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

System.Management.Automation.SwitchParameter

输出

System.Object

Set-ADSyncSchedulerConnectorOverride

摘要

设置同步计划程序的当前同步周期设置。

SYNTAX

ConnectorIdentifier

Set-ADSyncSchedulerConnectorOverride -ConnectorIdentifier <Guid> [-FullImportRequired <Boolean>]
[-FullSyncRequired <Boolean>] [<CommonParameters>]

ConnectorName

Set-ADSyncSchedulerConnectorOverride -ConnectorName <String> [-FullImportRequired <Boolean>]
[-FullSyncRequired <Boolean>] [<CommonParameters>]

DESCRIPTION

设置同步计划程序的当前同步周期设置。

示例

示例 1

PS C:\> Set-ADSyncSchedulerConnectorOverride -Connectorname "contoso.com" -FullImportRequired $true
-FullSyncRequired $false

将“contoso.com”连接器的同步周期设置设置为需要完全导入且无需完全同步。

PARAMETERS

-ConnectorIdentifier

连接器标识符。

Type: Guid
Parameter Sets: ConnectorIdentifier
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ConnectorName

连接器名称。

Type: String
Parameter Sets: ConnectorName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-FullImportRequired

设置为 true，以要求在下一个周期完全导入。

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-FullSyncRequired

设置为 true，以要求在下一个周期完全同步。

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

输入

System.Guid

System.String

System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

输出

System.Object

Start-ADSyncPurgeRunHistory

摘要

Cmdlet，用于清除早于指定时间跨度的运行历史记录。

SYNTAX

联机

Start-ADSyncPurgeRunHistory [[-PurgeRunHistoryInterval]  <TimeSpan>] [<CommonParameters>]

offline

Start-ADSyncPurgeRunHistory [-Offline] [<CommonParameters>]

DESCRIPTION

Cmdlet，用于清除早于指定时间跨度的运行历史记录。

示例

示例 1

PS C:\> Start-ADSyncPurgeRunHistory -PurgeRunHistoryInterval (New-Timespan -Hours 5)

清除所有超过 5 小时的运行历史记录。

PARAMETERS

-Offline

当服务处于脱机状态时，从数据库中清除所有运行历史记录。

Type: SwitchParameter
Parameter Sets: offline
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PurgeRunHistoryInterval

要保留其历史记录的时间间隔。

Type: TimeSpan
Parameter Sets: online
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

输入

System.TimeSpan

输出

System.Object

Start-ADSyncSyncCycle

摘要

触发同步周期。

SYNTAX

Start-ADSyncSyncCycle [[-PolicyType] <SynchronizationPolicyType>] [[-InteractiveMode] <Boolean>]
[<CommonParameters>]

DESCRIPTION

触发同步周期。

示例

示例 1

PS C:\> Start-ADSyncSyncCycle -PolicyType Initial

触发具有初始策略类型的同步周期。

PARAMETERS

-InteractiveMode

区分交互（命令行）模式和脚本/代码模式（来自其他代码的调用）。

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PolicyType

要运行的策略类型。接受的值：“未指定”、“Delta”、“初始值”。

Type: SynchronizationPolicyType
Parameter Sets: (All)
Aliases:
Accepted values: Unspecified, Delta, Initial

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

输入

System.Nullable`1[[Microsoft.IdentityManagement.PowerShell.ObjectModel.SynchronizationPolicyType, Microsoft.IdentityManagement.PowerShell.ObjectModel, Version=1.4.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

System.Boolean

输出

System.Object

Stop-ADSyncRunProfile

摘要

查找并停止所有或指定的繁忙连接器。

SYNTAX

Stop-ADSyncRunProfile [[-ConnectorName] <String>] [<CommonParameters>]

DESCRIPTION

查找并停止所有或指定的繁忙连接器。

示例

示例 1

PS C:\> Stop-ADSyncRunProfile -ConnectorName "contoso.com"

停止在“contoso.com”上运行的任何同步。

PARAMETERS

-ConnectorName

连接器的名称。如果没有给出，那么所有繁忙连接器都将停止。

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Stop-ADSyncSyncCycle

摘要

指示服务器停止当前运行的同步周期。

SYNTAX

Stop-ADSyncSyncCycle [<CommonParameters>]

DESCRIPTION

指示服务器停止当前运行的同步周期。

示例

示例 1

PS C:\> Stop-ADSyncSyncCycle

指示服务器停止当前运行的同步周期。

PARAMETERS

CommonParameters

输入

无

输出

System.Object

Sync-ADSyncCSObject

摘要

在连接器空间对象上运行同步预览。

SYNTAX

ConnectorName_ObjectDN

Sync-ADSyncCSObject -ConnectorName <String> -DistinguishedName <String> [-Commit] [<CommonParameters>]

ConnectorIdentifier_ObjectDN

Sync-ADSyncCSObject -ConnectorIdentifier <Guid> -DistinguishedName <String> [-Commit] [<CommonParameters>]

ObjectIdentifier

Sync-ADSyncCSObject -Identifier <Guid> [-Commit] [<CommonParameters>]

DESCRIPTION

在连接器空间对象上运行同步预览。

示例

示例 1

PS C:\> Sync-ADSyncCSObject -ConnectorName "contoso.com" -DistinguishedName "CN=fabrikam,CN=Users,DC=contoso,DC=com"

返回指定对象的同步预览。

PARAMETERS

-Commit

用于提交的参数开关。

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConnectorIdentifier

连接的标识符。

Type: Guid
Parameter Sets: ConnectorIdentifier_ObjectDN
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConnectorName

连接器的名称。

Type: String
Parameter Sets: ConnectorName_ObjectDN
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DistinguishedName

连接器空间对象的可分辨名称。

Type: String
Parameter Sets: ConnectorName_ObjectDN, ConnectorIdentifier_ObjectDN
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identifier

连接器空间对象的标识符。

Type: Guid
Parameter Sets: ObjectIdentifier
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

输入

无

输出

System.Object

Test-AdSyncAzureServiceConnectivity

摘要

调查并确定 Microsoft Entra ID 的连接问题。

SYNTAX

ByEnvironment

Test-AdSyncAzureServiceConnectivity [-AzureEnvironment] <Identifier> [[-Service] <AzureService>] [-CurrentUser]
[<CommonParameters>]

ByTenantName

Test-AdSyncAzureServiceConnectivity [-Domain] <String> [[-Service] <AzureService>] [-CurrentUser]
[<CommonParameters>]

DESCRIPTION

调查并确定 Microsoft Entra ID 的连接问题。

示例

示例 1

PS C:\> Test-AdSyncAzureServiceConnectivity -AzureEnvironment Worldwide -Service SecurityTokenService -CurrentUser

如果没有连接问题，则返回 True。

PARAMETERS

-AzureEnvironment

要测试的 Azure 环境。接受的值：全球、中国、美国政府、德国、AzureUSGovernmentCloud、AzureUSGovernmentCloud2、AzureUSGovernmentCloud3、PreProduction、OneBox、默认值。

Type: Identifier
Parameter Sets: ByEnvironment
Aliases:
Accepted values: Worldwide, China, UsGov, Germany, AzureUSGovernmentCloud, AzureUSGovernmentCloud2, AzureUSGovernmentCloud3, PreProduction, OneBox, Default

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-CurrentUser

运行 cmdlet 的用户。

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Domain

正在测试其连接性的域。

Type: String
Parameter Sets: ByTenantName
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Service

正在测试其连接性的服务。

Type: AzureService
Parameter Sets: (All)
Aliases:
Accepted values: SecurityTokenService, AdminWebService

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

输入

Microsoft.Online.Deployment.Client.Framework.MicrosoftOnlineInstance+Identifier

System.String

System.Nullable`1[[Microsoft.Online.Deployment.Client.Framework.AzureService, Microsoft.Online.Deployment.Client.Framework, Version=1.6.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

System.Management.Automation.SwitchParameter

输出

System.Object

Test-AdSyncUserHasPermissions

摘要

Cmdlet，用于检查 ADMA 用户是否具有所需的权限。

SYNTAX

Test-AdSyncUserHasPermissions [-ForestFqdn] <String> [-AdConnectorId] <Guid>
[-AdConnectorCredential] <PSCredential> [-BaseDn] <String> [-PropertyType] <String> [-PropertyValue] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Cmdlet，用于检查 ADMA 用户是否具有所需的权限。

示例

示例 1

PS C:\> Test-AdSyncUserHasPermissions -ForestFqdn "contoso.com" -AdConnectorId "00000000-0000-0000-000000000000"
-AdConnectorCredential $connectorAcctCreds -BaseDn "CN=fabrikam,CN=Users,DC=contoso,DC=com" -PropertyType "Allowed-Attributes" -PropertyValue "name"

检查 ADMA 用户是否有权访问用户 fabrikam 的 name 属性。

PARAMETERS

-AdConnectorCredential

AD 连接器帐户凭据。

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AdConnectorId

AD 连接器 ID。

Type: Guid
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-BaseDn

要检查的对象的基本 DN。

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForestFqdn

林的名称。

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PropertyType

要查找的权限类型。接受的值：Allowed-Attributes、Allowed-Attributes-Effective、Allowed-Child-Classes、Allowed-Child-Classes-Effective。

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyValue

在 PropertyType 属性中查找的值。

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

The future is yours

通过

Microsoft Entra Connect：ADSync PowerShell 参考

Add-ADSyncADDSConnectorAccount

摘要

SYNTAX

byIdentifier

byName

DESCRIPTION

示例

示例 1

PARAMETERS

-EACredential

-Identifier

-Name

CommonParameters

输入

System.Guid

System.String

输出

System.Object

Disable-ADSyncExportDeletionThreshold

摘要

SYNTAX

DESCRIPTION

示例

示例 1

PARAMETERS

-AADCredential

-Confirm

-WhatIf

CommonParameters

输入

System.Management.Automation.PSCredential

输出

System.Object

Enable-ADSyncExportDeletionThreshold

摘要

SYNTAX

DESCRIPTION

示例

示例 1

PARAMETERS

-AADCredential

-Confirm

-DeletionThreshold

-WhatIf

CommonParameters

输入

System.UInt32

System.Management.Automation.PSCredential

输出

System.Object

Get-ADSyncAutoUpgrade

摘要

SYNTAX

DESCRIPTION

示例

示例 1

PARAMETERS

-Detail

CommonParameters

输入

无

输出

System.Object

Get-ADSyncCSObject

摘要

SYNTAX

SearchByIdentifier

SearchByConnectorIdentifierDistinguishedName

SearchByConnectorIdentifier

SearchByConnectorNameDistinguishedName

SearchByConnectorName

DESCRIPTION

示例

示例 1

PARAMETERS

-ConnectorIdentifier

-ConnectorName