Update-MgBetaDirectoryOnPremiseSynchronization
Update the properties of an onPremisesDirectorySynchronization object.
Note
To view the v1.0 release of this cmdlet, view Update-MgDirectoryOnPremiseSynchronization
Syntax
Update-MgBetaDirectoryOnPremiseSynchronization
-OnPremisesDirectorySynchronizationId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Configuration <IMicrosoftGraphOnPremisesDirectorySynchronizationConfiguration>]
[-Features <IMicrosoftGraphOnPremisesDirectorySynchronizationFeature>]
[-Id <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaDirectoryOnPremiseSynchronization
-OnPremisesDirectorySynchronizationId <String>
-BodyParameter <IMicrosoftGraphOnPremisesDirectorySynchronization>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaDirectoryOnPremiseSynchronization
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Configuration <IMicrosoftGraphOnPremisesDirectorySynchronizationConfiguration>]
[-Features <IMicrosoftGraphOnPremisesDirectorySynchronizationFeature>]
[-Id <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaDirectoryOnPremiseSynchronization
-InputObject <IIdentityDirectoryManagementIdentity>
-BodyParameter <IMicrosoftGraphOnPremisesDirectorySynchronization>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Update the properties of an onPremisesDirectorySynchronization object.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | OnPremDirectorySynchronization.ReadWrite.All | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Not supported. | Not supported. |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
configuration = @{
accidentalDeletionPrevention = @{
synchronizationPreventionType = "enabledForCount"
alertThreshold = 500
}
synchronizationInterval = "PT30M"
customerRequestedSynchronizationInterval = "PT1H"
}
features = @{
groupWriteBackEnabled = $true
}
}
Update-MgBetaDirectoryOnPremiseSynchronization -OnPremisesDirectorySynchronizationId $onPremisesDirectorySynchronizationId -BodyParameter $paramsThis example shows how to use the Update-MgBetaDirectoryOnPremiseSynchronization Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
onPremisesDirectorySynchronization To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphOnPremisesDirectorySynchronization |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Configuration
onPremisesDirectorySynchronizationConfiguration To construct, see NOTES section for CONFIGURATION properties and create a hash table.
| Type: | IMicrosoftGraphOnPremisesDirectorySynchronizationConfiguration |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Features
onPremisesDirectorySynchronizationFeature To construct, see NOTES section for FEATURES properties and create a hash table.
| Type: | IMicrosoftGraphOnPremisesDirectorySynchronizationFeature |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IIdentityDirectoryManagementIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OnPremisesDirectorySynchronizationId
The unique identifier of onPremisesDirectorySynchronization
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphOnPremisesDirectorySynchronization
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphOnPremisesDirectorySynchronization
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IMicrosoftGraphOnPremisesDirectorySynchronization>: onPremisesDirectorySynchronization
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Configuration <IMicrosoftGraphOnPremisesDirectorySynchronizationConfiguration>]: onPremisesDirectorySynchronizationConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[AccidentalDeletionPrevention <IMicrosoftGraphOnPremisesAccidentalDeletionPrevention>]: onPremisesAccidentalDeletionPrevention[(Any) <Object>]: This indicates any property can be added to this object.[AlertThreshold <Int32?>]: Threshold value which triggers accidental deletion prevention. The threshold is either an absolute number of objects or a percentage number of objects.[SynchronizationPreventionType <String>]: onPremisesDirectorySynchronizationDeletionPreventionType
[AnchorAttribute <String>]: The anchor attribute allows customers to customize the property used to create source anchors for synchronization enabled objects.[ApplicationId <String>]: The identifier of the on-premises directory synchronization client application that is configured for the tenant.[CurrentExportData <IMicrosoftGraphOnPremisesCurrentExportData>]: onPremisesCurrentExportData[(Any) <Object>]: This indicates any property can be added to this object.[ClientMachineName <String>]: The name of the onPremises client machine that ran the last export.[PendingObjectsAddition <Int32?>]: The count of pending adds from on-premises directory.[PendingObjectsDeletion <Int32?>]: The count of pending deletes from on-premises directory.[PendingObjectsUpdate <Int32?>]: The count of pending updates from on-premises directory.[ServiceAccount <String>]: The name of the dirsync service account that is configured to connect to the directory.[SuccessfulLinksProvisioningCount <Int64?>]: The count of updated links during the current directory sync export run.[SuccessfulObjectsProvisioningCount <Int32?>]: The count of objects that were successfully provisioned during the current directory sync export run.[TotalConnectorSpaceObjects <Int32?>]: The total number of objects in the AAD Connector Space.
[CustomerRequestedSynchronizationInterval <TimeSpan?>]: Interval of time that the customer requested the sync client waits between sync cycles.[SynchronizationClientVersion <String>]: Indicates the version of the on-premises directory synchronization application.[SynchronizationInterval <TimeSpan?>]: Interval of time the sync client should honor between sync cycles[WritebackConfiguration <IMicrosoftGraphOnPremisesWritebackConfiguration>]: onPremisesWritebackConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[UnifiedGroupContainer <String>]: The distinguished name of the on-premises container that the customer is using to store unified groups which are created in the cloud.[UserContainer <String>]: The distinguished name of the on-premises container that the customer is using to store users which are created in the cloud.
[Features <IMicrosoftGraphOnPremisesDirectorySynchronizationFeature>]: onPremisesDirectorySynchronizationFeature[(Any) <Object>]: This indicates any property can be added to this object.[BlockCloudObjectTakeoverThroughHardMatchEnabled <Boolean?>]: Used to block cloud object takeover via source anchor hard match if enabled.[BlockSoftMatchEnabled <Boolean?>]: Use to block soft match for all objects if enabled for the tenant. Customers are encouraged to enable this feature and keep it enabled until soft matching is required again for their tenancy. This flag should be enabled again after any soft matching has been completed and is no longer needed.[BypassDirSyncOverridesEnabled <Boolean?>]: When true, persists the values of Mobile and OtherMobile in on-premises AD during sync cycles instead of values of MobilePhone or AlternateMobilePhones in Microsoft Entra ID.[CloudPasswordPolicyForPasswordSyncedUsersEnabled <Boolean?>]: Used to indicate that cloud password policy applies to users whose passwords are synchronized from on-premises.[ConcurrentCredentialUpdateEnabled <Boolean?>]: Used to enable concurrent user credentials update in OrgId.[ConcurrentOrgIdProvisioningEnabled <Boolean?>]: Used to enable concurrent user creation in OrgId.[DeviceWritebackEnabled <Boolean?>]: Used to indicate that device write-back is enabled.[DirectoryExtensionsEnabled <Boolean?>]: Used to indicate that directory extensions are being synced from on-premises AD to Microsoft Entra ID.[FopeConflictResolutionEnabled <Boolean?>]: Used to indicate that for a Microsoft Forefront Online Protection for Exchange (FOPE) migrated tenant, the conflicting proxy address should be migrated over.[GroupWriteBackEnabled <Boolean?>]: Used to enable object-level group writeback feature for additional group types.[PasswordSyncEnabled <Boolean?>]: Used to indicate on-premise password synchronization is enabled.[PasswordWritebackEnabled <Boolean?>]: Used to indicate that writeback of password resets from Microsoft Entra ID to on-premises AD is enabled.[QuarantineUponProxyAddressesConflictEnabled <Boolean?>]: Used to indicate that we should quarantine objects with conflicting proxy address.[QuarantineUponUpnConflictEnabled <Boolean?>]: Used to indicate that we should quarantine objects conflicting with duplicate userPrincipalName.[SoftMatchOnUpnEnabled <Boolean?>]: Used to indicate that we should soft match objects based on userPrincipalName.[SynchronizeUpnForManagedUsersEnabled <Boolean?>]: Used to indicate that we should synchronize userPrincipalName objects for managed users with licenses.[UnifiedGroupWritebackEnabled <Boolean?>]: Used to indicate that Microsoft 365 Group write-back is enabled.[UserForcePasswordChangeOnLogonEnabled <Boolean?>]: Used to indicate that feature to force password change for a user on logon is enabled while synchronizing on-premise credentials.[UserWritebackEnabled <Boolean?>]: Used to indicate that user writeback is enabled.
CONFIGURATION <IMicrosoftGraphOnPremisesDirectorySynchronizationConfiguration>: onPremisesDirectorySynchronizationConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.[AccidentalDeletionPrevention <IMicrosoftGraphOnPremisesAccidentalDeletionPrevention>]: onPremisesAccidentalDeletionPrevention[(Any) <Object>]: This indicates any property can be added to this object.[AlertThreshold <Int32?>]: Threshold value which triggers accidental deletion prevention. The threshold is either an absolute number of objects or a percentage number of objects.[SynchronizationPreventionType <String>]: onPremisesDirectorySynchronizationDeletionPreventionType
[AnchorAttribute <String>]: The anchor attribute allows customers to customize the property used to create source anchors for synchronization enabled objects.[ApplicationId <String>]: The identifier of the on-premises directory synchronization client application that is configured for the tenant.[CurrentExportData <IMicrosoftGraphOnPremisesCurrentExportData>]: onPremisesCurrentExportData[(Any) <Object>]: This indicates any property can be added to this object.[ClientMachineName <String>]: The name of the onPremises client machine that ran the last export.[PendingObjectsAddition <Int32?>]: The count of pending adds from on-premises directory.[PendingObjectsDeletion <Int32?>]: The count of pending deletes from on-premises directory.[PendingObjectsUpdate <Int32?>]: The count of pending updates from on-premises directory.[ServiceAccount <String>]: The name of the dirsync service account that is configured to connect to the directory.[SuccessfulLinksProvisioningCount <Int64?>]: The count of updated links during the current directory sync export run.[SuccessfulObjectsProvisioningCount <Int32?>]: The count of objects that were successfully provisioned during the current directory sync export run.[TotalConnectorSpaceObjects <Int32?>]: The total number of objects in the AAD Connector Space.
[CustomerRequestedSynchronizationInterval <TimeSpan?>]: Interval of time that the customer requested the sync client waits between sync cycles.[SynchronizationClientVersion <String>]: Indicates the version of the on-premises directory synchronization application.[SynchronizationInterval <TimeSpan?>]: Interval of time the sync client should honor between sync cycles[WritebackConfiguration <IMicrosoftGraphOnPremisesWritebackConfiguration>]: onPremisesWritebackConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[UnifiedGroupContainer <String>]: The distinguished name of the on-premises container that the customer is using to store unified groups which are created in the cloud.[UserContainer <String>]: The distinguished name of the on-premises container that the customer is using to store users which are created in the cloud.
FEATURES <IMicrosoftGraphOnPremisesDirectorySynchronizationFeature>: onPremisesDirectorySynchronizationFeature
[(Any) <Object>]: This indicates any property can be added to this object.[BlockCloudObjectTakeoverThroughHardMatchEnabled <Boolean?>]: Used to block cloud object takeover via source anchor hard match if enabled.[BlockSoftMatchEnabled <Boolean?>]: Use to block soft match for all objects if enabled for the tenant. Customers are encouraged to enable this feature and keep it enabled until soft matching is required again for their tenancy. This flag should be enabled again after any soft matching has been completed and is no longer needed.[BypassDirSyncOverridesEnabled <Boolean?>]: When true, persists the values of Mobile and OtherMobile in on-premises AD during sync cycles instead of values of MobilePhone or AlternateMobilePhones in Microsoft Entra ID.[CloudPasswordPolicyForPasswordSyncedUsersEnabled <Boolean?>]: Used to indicate that cloud password policy applies to users whose passwords are synchronized from on-premises.[ConcurrentCredentialUpdateEnabled <Boolean?>]: Used to enable concurrent user credentials update in OrgId.[ConcurrentOrgIdProvisioningEnabled <Boolean?>]: Used to enable concurrent user creation in OrgId.[DeviceWritebackEnabled <Boolean?>]: Used to indicate that device write-back is enabled.[DirectoryExtensionsEnabled <Boolean?>]: Used to indicate that directory extensions are being synced from on-premises AD to Microsoft Entra ID.[FopeConflictResolutionEnabled <Boolean?>]: Used to indicate that for a Microsoft Forefront Online Protection for Exchange (FOPE) migrated tenant, the conflicting proxy address should be migrated over.[GroupWriteBackEnabled <Boolean?>]: Used to enable object-level group writeback feature for additional group types.[PasswordSyncEnabled <Boolean?>]: Used to indicate on-premise password synchronization is enabled.[PasswordWritebackEnabled <Boolean?>]: Used to indicate that writeback of password resets from Microsoft Entra ID to on-premises AD is enabled.[QuarantineUponProxyAddressesConflictEnabled <Boolean?>]: Used to indicate that we should quarantine objects with conflicting proxy address.[QuarantineUponUpnConflictEnabled <Boolean?>]: Used to indicate that we should quarantine objects conflicting with duplicate userPrincipalName.[SoftMatchOnUpnEnabled <Boolean?>]: Used to indicate that we should soft match objects based on userPrincipalName.[SynchronizeUpnForManagedUsersEnabled <Boolean?>]: Used to indicate that we should synchronize userPrincipalName objects for managed users with licenses.[UnifiedGroupWritebackEnabled <Boolean?>]: Used to indicate that Microsoft 365 Group write-back is enabled.[UserForcePasswordChangeOnLogonEnabled <Boolean?>]: Used to indicate that feature to force password change for a user on logon is enabled while synchronizing on-premise credentials.[UserWritebackEnabled <Boolean?>]: Used to indicate that user writeback is enabled.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter
[AdministrativeUnitId <String>]: The unique identifier of administrativeUnit[AllowedValueId <String>]: The unique identifier of allowedValue[AttributeSetId <String>]: The unique identifier of attributeSet[CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity[CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration[CommandId <String>]: The unique identifier of command[CommerceSubscriptionId <String>]: Alternate key of companySubscription[CompanySubscriptionId <String>]: The unique identifier of companySubscription[ContractId <String>]: The unique identifier of contract[CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition[DeviceId <String>]: The unique identifier of device[DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo[DirectoryObjectId <String>]: The unique identifier of directoryObject[DirectoryRoleId <String>]: The unique identifier of directoryRole[DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate[DirectorySettingId <String>]: The unique identifier of directorySetting[DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate[DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord[DomainId <String>]: The unique identifier of domain[ExtensionId <String>]: The unique identifier of extension[ExternalUserProfileId <String>]: The unique identifier of externalUserProfile[FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy[IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase[ImpactedResourceId <String>]: The unique identifier of impactedResource[InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile[InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation[ManagedTenantAlertId <String>]: The unique identifier of managedTenantAlert[ManagementActionId <String>]: The unique identifier of managementAction[OcpSubscriptionId <String>]: Alternate key of companySubscription[OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization[OrgContactId <String>]: The unique identifier of orgContact[OrganizationId <String>]: The unique identifier of organization[OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization[OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile[PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile[ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty[RecommendationId <String>]: The unique identifier of recommendation[RoleTemplateId <String>]: Alternate key of directoryRole[ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership[SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain[SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation[SubscribedSkuId <String>]: The unique identifier of subscribedSku[TenantId <String>]: The unique identifier of tenant[TenantReferenceTenantId <String>]: The unique identifier of tenantReference[TenantTagId <String>]: The unique identifier of tenantTag[UsageRightId <String>]: The unique identifier of usageRight[UserId <String>]: The unique identifier of user
RELATED LINKS
https://learn.microsoft.com/graph/api/onpremisesdirectorysynchronization-update?view=graph-rest-beta