This content is 9 years old. I don't routinely update old blog posts as they are only intended to represent a view at a particular point in time. Please be warned that the information here may be out of date.
MVP, Mike Crowley wrote a blog post last year that details the cmdlets for managing Azure AD Directory Synchronisation (DirSync). Unfortunately, the latest incarnation of DirSync (Azure AD Connect) uses a totally different set of commands (and they seem to me to be more complex to use – thank goodness the GUI is so good now).
I used Mike’s method to extract the details of the PowerShell cmdlets in the Azure ADSync module:
Import-Module ADSync
Get-Command -Module ADSync | Get-Help | Select name, synopsis | Export-Csv $env:userprofile\Desktop\DirSyncCmdlets.csv -NoTypeInformation
Unfortunately the help information is very sparse so the synopsis is missing. Aaron Peterson has some extra information on the ADSync cmdlets but it seems we’ve gone backwards in terms of help…
My final attempt was Get-Command -Module ADSync | Select definition | Export-Csv $env:userprofile\Desktop\DirSyncCmdlets.csv -NoTypeInformation which allowed me to at least pull out the syntax for each cmdlet:
Add-ADSyncAADServiceAccount [-AADCredential] [[-Name] ] [] Add-ADSyncAttributeFlowMapping [-SynchronizationRule] [-AttributeFlowMappings] <List[AttributeFlowMapping]> [-Direction ] [-WhatIf] [-Confirm] [] Add-ADSyncAttributeFlowMapping [[-Source] <List[string]>] [-Destination] [-FlowType] [[-ValueMergeType] ] [-SynchronizationRule ] [-Expression ] [-ExecuteOnce] [-Direction ] [-WhatIf] [-Confirm] [] Add-ADSyncConnector [[-Connector] ] [] Add-ADSyncConnector [-Name] [-Type] [-Description ] [-ConnectivityParameterSettings ] [-GlobalParameterSettings ] [-HierarchyProvisioningMappings <Dictionary[string,string]>] [-Partitions <List[ConnectorPartition]>] [-PasswordManagementSettings ] [] Add-ADSyncConnectorAnchorConstructionSettings [-Connector] [-ObjectClass] [-Locked] [-Attributes] <List[string]> [] Add-ADSyncConnectorAttributeInclusion [-Connector] [-AttributeTypes] <List[string]> [] Add-ADSyncConnectorHierarchyProvisioningMapping [-Connector ] [-Mappings <Dictionary[string,string]>] [] Add-ADSyncConnectorHierarchyProvisioningMapping [-Connector] [[-DNComponent] ] [[-ObjectClass] ] [] Add-ADSyncConnectorObjectInclusion [-Connector] [-ObjectTypes] <List[string]> [] Add-ADSyncGlobalSettingsParameter [-GlobalSettings] [-ParameterValuesTable] [] Add-ADSyncGlobalSettingsParameter [-GlobalSettings] [-Parameters] <List[ConfigurationParameter]> [] Add-ADSyncJoinConditionGroup [-SynchronizationRule] [-JoinConditions] <List[JoinCondition]> [-WhatIf] [-Confirm] [] Add-ADSyncRule [-SynchronizationRule] [-WhatIf] [-Confirm] [] Add-ADSyncRule -Name -Connector -Direction -SourceObjectType -TargetObjectType [-Precedence ] [-PrecedenceAfter ] [-PrecedenceBefore ] [-Description ] [-Identifier ] [-ImmutableTag ] [-ScopeFilter <List[ScopeConditionGroup]>] [-JoinFilter <List[JoinConditionGroup]>] [-LinkType ] [-EnablePasswordSync] [-AttributeFlowMappings <List[AttributeFlowMapping]>] [-SoftDeleteExpiryInterval ] [-WhatIf] [-Confirm] [] Add-ADSyncRunProfile [-RunProfile] [] Add-ADSyncRunProfile [-Name] [-ConnectorIdentifier] [-RunSteps <List[RunStep]>] [] Add-ADSyncRunProfile [-Name ] [-ConnectorIdentifier ] [-RunStepPartitionIdentifier ] [-RunStepTask ] [-RunStepObjectProcessLimit ] [-RunStepObjectDeleteLimit ] [-RunStepBatchSize ] [-RunStepLogType ] [-RunStepLogFile ] [] Add-ADSyncRunStep [-RunProfile] [-PartitionIdentifier] [-StepTask] [-BatchSize ] [-ConnectorType ] [-Index ] [-LogType ] [-LogFile ] [-ObjectProcessLimit ] [-ObjectDeleteLimit ] [-PageSize ] [-Timeout ] [] Add-ADSyncScopeConditionGroup [-SynchronizationRule] [-ScopeConditions] <List[ScopeCondition]> [-WhatIf] [-Confirm] [] Disable-ADSyncConnectorPartition [-Partitions] <List[ConnectorPartition]> [-Connector ] [] Disable-ADSyncConnectorPartition [-Connector] [-Partition] [] Disable-ADSyncConnectorPartitionHierarchy [-Connector] [-Partition] [-PartitionHierarchyNode] [] Disable-ADSyncExportDeletionThreshold [-AADCredential] [-WhatIf] [-Confirm] [] Enable-ADSyncConnectorPartition [-Partitions] <List[ConnectorPartition]> [-Connector ] [] Enable-ADSyncConnectorPartition [-Connector] [-Partition] [] Enable-ADSyncConnectorPartitionHierarchy [-Connector] [-Partition] [-PartitionHierarchyNode] [] Enable-ADSyncExportDeletionThreshold [-AADCredential] [-DeletionThreshold] [-WhatIf] [-Confirm] [] Get-ADSyncAADPasswordResetConfiguration [-Connector] [] Get-ADSyncAADPasswordSyncConfiguration [-SourceConnector] [] Get-ADSyncConnector [-Identifier ] [-Name ] [] Get-ADSyncConnectorHierarchyProvisioningDNComponent [-Connector] [[-ObjectType] ] [-ShowHidden] [] Get-ADSyncConnectorHierarchyProvisioningMapping [-Connector] [] Get-ADSyncConnectorHierarchyProvisioningObjectClass [-DNComponent] [] Get-ADSyncConnectorParameter -Type [-Identifier ] [-Connector ] [-ScopeIdentifier ] [] Get-ADSyncConnectorPartition [-Connector] [-Identifier ] [-Name ] [] Get-ADSyncConnectorPartitionHierarchy [-Connector] [-Partition] [-ParentPartitionHierarchyNode ] [] Get-ADSyncConnectorTypes [] Get-ADSyncGlobalSettings [-WhatIf] [-Confirm] [] Get-ADSyncGlobalSettingsParameter [] Get-ADSyncRule [[-Identifier] ] [-WhatIf] [-Confirm] [] Get-ADSyncRunProfile [-Connector] [] Get-ADSyncRunProfile [-Identifier] [] Get-ADSyncSchema [-Connector ] [-Identifier ] [] Get-ADSyncServerConfiguration [-Path] [] New-ADSyncConnector [-Name] [-Type] [-Description ] [-ExtensionFileName ] [] New-ADSyncJoinCondition [-CSAttribute] [-MVAttribute] [[-CaseSensitive] ] [-WhatIf] [-Confirm] [] New-ADSyncRule [-Name] [-Direction] [-Connector] [-SourceObjectType] [-TargetObjectType] [-LinkType] [-Precedence ] [-EnablePasswordSync] [-PrecedenceAfter ] [-PrecedenceBefore ] [-Description ] [-ImmutableTag ] [-Identifier ] [-SoftDeleteExpiryInterval ] [-WhatIf] [-Confirm] [] New-ADSyncRunProfile [-Connector] [-Name] [] New-ADSyncScopeCondition [-Attribute] [-ComparisonValue] [-ComparisonOperator] [-WhatIf] [-Confirm] [] Remove-ADSyncAADPasswordResetConfiguration [-Connector] [[-AADCredential] ] [] Remove-ADSyncAADPasswordSyncConfiguration [-SourceConnector] [] Remove-ADSyncAADServiceAccount [-AADCredential] [-Name] [-WhatIf] [-Confirm] [] Remove-ADSyncAttributeFlowMapping [-SynchronizationRule] [-AttributeFlowMappings] <List[AttributeFlowMapping]> [-WhatIf] [-Confirm] [] Remove-ADSyncConnector [[-Connector] ] [-WhatIf] [-Confirm] [] Remove-ADSyncConnector [[-Identifier] ] [-WhatIf] [-Confirm] [] Remove-ADSyncConnector [[-Name] ] [-WhatIf] [-Confirm] [] Remove-ADSyncConnectorAnchorConstructionSettings [-Connector] [-ObjectClass] [] Remove-ADSyncConnectorAttributeInclusion [-Connector] [-AttributeTypes] <List[string]> [] Remove-ADSyncConnectorHierarchyProvisioningMapping [-Connector] [-DNComponent ] [-WhatIf] [-Confirm] [] Remove-ADSyncConnectorHierarchyProvisioningMapping [-DNComponent] [-Connector ] [-DNComponents <List[string]>] [-WhatIf] [-Confirm] [ Remove-ADSyncConnectorObjectInclusion [-Connector] [-ObjectTypes] <List[string]> [] Remove-ADSyncGlobalSettingsParameter [-GlobalSettings] [-ParameterNames] <List[string]> [] Remove-ADSyncJoinConditionGroup [-SynchronizationRule] [-Index] [-WhatIf] [-Confirm] [] Remove-ADSyncRule [-SynchronizationRule] [-WhatIf] [-Confirm] [] Remove-ADSyncRule [-Identifier] [-WhatIf] [-Confirm] [] Remove-ADSyncRunProfile [-RunProfile] [-WhatIf] [-Confirm] [] Remove-ADSyncRunStep [-RunProfile] [-RunStep] [-WhatIf] [-Confirm] [ Remove-ADSyncScopeConditionGroup [-SynchronizationRule] [-Index] [-WhatIf] [-Confirm] [] Search-ADSyncDirectoryObjects [[-ForestFqdn] ] [-AdConnectorId] [[-PropertiesToRetrieve] <string[]>] [[-NamingContextType] ] [[-BaseDnType] ] [[-AdConnectorCredential] ] [[-BaseDn] ] [[-LdapFilter] ] [[-SearchScope] ] [-WhatIf] [-Confirm] [] Set-ADSyncAADCompanyFeature [-ConnectorName] [-ForcePasswordResetOnLogonFeature ] [-PasswordHashSyncFeature ] [] Set-ADSyncAADPasswordResetConfiguration [-Connector] [-Enable] [[-AADCredential] ] [] Set-ADSyncAADPasswordSyncConfiguration [-SourceConnector] [-TargetConnector] [-Enable] [[-PasswordAgentCredentials] ] [] Set-ADSyncAADPasswordSyncState [-ConnectorName] [-Enable] [] Set-ADSyncConnectorParameter -Type [-Connector ] [-PartitionIdentifier ] [-RunProfileIdentifier ] [-RunStepIdentifier ] [-ParameterValues ] [] Set-ADSyncGlobalSettings [-GlobalSettings] [-WhatIf] [-Confirm] [] Set-ADSyncSchema [-Schema] [] Set-ADSyncSchema [-SchemaFile] [] Set-ADSyncServerConfiguration [-Path] [] Set-MIISADMAConfiguration [-Id] -Credentials -Forest [-Container ] [-AllowUnreachableDomains] [-WhatIf] [-Confirm] [] Test-AdSyncUserHasPermissions [-ForestFqdn] [-AdConnectorId] [-AdConnectorCredential] [-BaseDn] [-PropertyType] [-PropertyValue] [-WhatIf] [-Confirm] [] Update-ADSyncConnectorPartition [-Connector] [] Update-ADSyncConnectorSchema [-Connector] [-WhatIf] [-Confirm] [] Update-ADSyncDRSCertificates [-DeviceWriteBackConnectorName] [-AadConnectorName] [-WhatIf] [-Confirm] []
2 thoughts on “PowerShell cmdlets in the Azure ADSync module”