Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-CMOneDriveBusinessProfile
- Module:
- ConfigurationManager Module
Configure a OneDrive for Business profile policy.
Syntax
ByName (Default)
Set-CMOneDriveBusinessProfile
-Name <String>
[-AddSupportedPlatform <IResultObject[]>]
[-ClearSupportedPlatform]
[-Description <String>]
[-KnownFolderMoveOption <MoveKnownFolderOptionType>]
[-NewName <String>]
[-O365TenantId <String>]
[-PreventRedirectKnownFolders <Boolean>]
[-RemoveSupportedPlatform <IResultObject[]>]
[-ShowNotification <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ById
Set-CMOneDriveBusinessProfile
-Id <Int32>
[-AddSupportedPlatform <IResultObject[]>]
[-ClearSupportedPlatform]
[-Description <String>]
[-KnownFolderMoveOption <MoveKnownFolderOptionType>]
[-NewName <String>]
[-O365TenantId <String>]
[-PreventRedirectKnownFolders <Boolean>]
[-RemoveSupportedPlatform <IResultObject[]>]
[-ShowNotification <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByValue
Set-CMOneDriveBusinessProfile
-InputObject <IResultObject>
[-AddSupportedPlatform <IResultObject[]>]
[-ClearSupportedPlatform]
[-Description <String>]
[-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.
Parameter properties
| Type: | IResultObject[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AddSupportedPlatforms |
Parameter sets
-ClearSupportedPlatform
Add this parameter to clear the current list of supported platforms.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-Description
Specify an optional description for the OneDrive for Business policy to better identify it.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | LocalizedDescription |
Parameter sets
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CI_ID, CIId |
Parameter sets
-InputObject
Specify a OneDrive for Business policy object to configure. To get this object, use the Get-CMOneDriveBusinessProfile cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | OneDriveBusinessPolicy |
Parameter sets
-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.
Parameter properties
| Type: | MoveKnownFolderOptionType |
| Default value: | None |
| Accepted values: | PromptToMove, SilentlyMove |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | OneDriveKnownFolderMoveOption |
Parameter sets
-Name
Specify the name of the OneDrive for Business policy to configure.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | LocalizedDisplayName |
Parameter sets
-NewName
To rename this OneDrive for Business policy, specify a new name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-O365TenantId
Specify your Microsoft 365 tenant ID. Find your Microsoft 365 tenant ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AADTenantId |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RemoveSupportedPlatform
Specify a supported platform object to remove from this policy. To get this object, use the Get-CMSupportedPlatform cmdlet.
Parameter properties
| Type: | IResultObject[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RemoveSupportedPlatforms |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
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
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject
Related Links
Feedback
Was this page helpful?