Set-CMOneDriveBusinessProfile

Module:

ConfigurationManager

Configure a OneDrive for Business profile policy.

Syntax

Set-CMOneDriveBusinessProfile
   [-AddSupportedPlatform <IResultObject[]>]
   [-ClearSupportedPlatform]
   [-Description <String>]
   [-KnownFolderMoveOption <MoveKnownFolderOptionType>]
   -Name <String>
   [-NewName <String>]
   [-O365TenantId <String>]
   [-PreventRedirectKnownFolders <Boolean>]
   [-RemoveSupportedPlatform <IResultObject[]>]
   [-ShowNotification <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMOneDriveBusinessProfile
   [-AddSupportedPlatform <IResultObject[]>]
   [-ClearSupportedPlatform]
   [-Description <String>]
   -Id <Int32>
   [-KnownFolderMoveOption <MoveKnownFolderOptionType>]
   [-NewName <String>]
   [-O365TenantId <String>]
   [-PreventRedirectKnownFolders <Boolean>]
   [-RemoveSupportedPlatform <IResultObject[]>]
   [-ShowNotification <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMOneDriveBusinessProfile
   [-AddSupportedPlatform <IResultObject[]>]
   [-ClearSupportedPlatform]
   [-Description <String>]
   -InputObject <IResultObject>
   [-KnownFolderMoveOption <MoveKnownFolderOptionType>]
   [-NewName <String>]
   [-O365TenantId <String>]
   [-PreventRedirectKnownFolders <Boolean>]
   [-RemoveSupportedPlatform <IResultObject[]>]
   [-ShowNotification <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Configure a OneDrive for Business profile policy. Use this policy to move Windows known folders to OneDrive for Business. These folders include Desktop, Documents, and Pictures. In each profile, you can specify settings for moving the Windows known folders. For more information on OneDrive for Business, see Redirect and move Windows known folders to OneDrive.

For more information on this Configuration Manager policy, see OneDrive for Business profiles.

Examples

Example 1

$Plats2 = Get-CMSupportedPlatform -Name "All Windows 10 *" -Fast -Platform "X64"

Set-CMOneDriveBusinessProfile -Name "ODfB policy" -ClearSupportedPlatform -AddSupportedPlatform $Plats2 -O365TenantId "05d683b9-caed-4eea-b229-45f72b89ca05" -KnownFolderMoveOption SilentlyMove -ShowNotification $true -PreventRedirectKnownFolders $true

Parameters

-AddSupportedPlatform

Specify a supported platform object to which this policy is applicable. To get this object, use the Get-CMSupportedPlatform cmdlet.

Type:	IResultObject[]
Aliases:	AddSupportedPlatforms
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClearSupportedPlatform

Add this parameter to clear the current list of supported platforms.

Type:	SwitchParameter
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

-Description

Specify an optional description for the OneDrive for Business policy to better identify it.

Type:	String
Aliases:	LocalizedDescription
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-Id

Specify the CI ID of the OneDrive for Business policy to configure. The format is a five- to seven-digit number, for example 403823.

Type:	Int32
Aliases:	CI_ID, CIId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specify a OneDrive for Business policy object to configure. To get this object, use the Get-CMOneDriveBusinessProfile cmdlet.

Type:	IResultObject
Aliases:	OneDriveBusinessPolicy
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-KnownFolderMoveOption

Specify how you want to move the known folders to OneDrive:

• PromptToMove: Prompt users to move Windows known folders to OneDrive. The user sees a wizard to move their files. If they choose to postpone or decline moving their folders, OneDrive periodically reminds them.
• SilentlyMove: Silently move Windows known folders to OneDrive. When this policy applies to the device, the OneDrive client automatically redirects the known folders to OneDrive for Business.

Type:	MoveKnownFolderOptionType
Aliases:	OneDriveKnownFolderMoveOption
Accepted values:	PromptToMove, SilentlyMove
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specify the name of the OneDrive for Business policy to configure.

Type:	String
Aliases:	LocalizedDisplayName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NewName

To rename this OneDrive for Business policy, specify a new name.

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

-O365TenantId

Specify your Microsoft 365 tenant ID. Find your Microsoft 365 tenant ID.

Type:	String
Aliases:	AADTenantId
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreventRedirectKnownFolders

Set this parameter to $true to prevent users from redirecting their Windows known folders back to their PC. It disables the option in OneDrive for Business on the client for users to move these folders back to the device.

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

-RemoveSupportedPlatform

Specify a supported platform object to remove from this policy. To get this object, use the Get-CMSupportedPlatform cmdlet.

Type:	IResultObject[]
Aliases:	RemoveSupportedPlatforms
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ShowNotification

When you use SilentlyMove for the KnownFolderMoveOption parameter, if you set this parameter to $true, the OneDrive client notifies the user after it moves their folders.

Type:	Boolean
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 doesn't run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject

Related Links

• Get-CMOneDriveBusinessProfile
• New-CMOneDriveBusinessProfile
• OneDrive for Business profiles