ODSettings¶
Parameters¶
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
IsSingleInstance | Key | String | Should be set to yes | Yes |
OneDriveStorageQuota | Write | UInt32 | The resource quota to apply to the OneDrive sites | |
OrphanedPersonalSitesRetentionPeriod | Write | UInt32 | Number of days after a user's account is deleted that their OneDrive for Business content will be deleted. | |
OneDriveForGuestsEnabled | Write | Boolean | Enable guest acess for OneDrive | |
NotifyOwnersWhenInvitationsAccepted | Write | Boolean | When true and when an external user accepts an invitation to a resource in a userâs OneDrive for Business owner is notified by e-mail | |
NotificationsInOneDriveForBusinessEnabled | Write | Boolean | Turn notifications on/off OneDrive | |
ODBMembersCanShare | Write | String | Lets administrators set policy on re-sharing behavior in OneDrive for Business | On, Off, Unspecified |
ODBAccessRequests | Write | String | Lets administrators set policy on access requests and requests to share in OneDrive for Business | On, Off, Unspecified |
BlockMacSync | Write | Boolean | Block sync client on Mac | |
DisableReportProblemDialog | Write | Boolean | Disable dialog box | |
DomainGuids | Write | StringArray[] | Safe domain list | |
ExcludedFileExtensions | Write | StringArray[] | Exclude files from being synced to OneDrive | |
GrooveBlockOption | Write | String | Groove block options | OptOut, HardOptIn, SoftOptIn |
Ensure | Write | String | Present ensures the user exists, absent ensures it is removed | Present, Absent |
Credential | Write | PSCredential | Credentials of the account to authenticate with. | |
ApplicationId | Write | String | Id of the Azure Active Directory application to authenticate with. | |
TenantId | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com | |
CertificatePassword | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword | |
CertificatePath | Write | String | Path to certificate used in service principal usually a PFX file. | |
CertificateThumbprint | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. |
ODSettings¶
Description¶
This resource allows admins to manage blocked file types, blocked domains and MAC Sync.
Azure AD Permissions¶
To authenticate via Azure Active Directory, this resource required the following Application permissions:
- Automate
- SharePoint
- Sites.FullControl.All
- Export
- SharePoint
- Sites.FullControl.All
NOTE: All permisions listed above require admin consent.
Examples¶
Example 1¶
This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$credsGlobalAdmin
)
Import-DscResource -ModuleName Microsoft365DSC
node localhost
{
ODSettings 'OneDriveSettings'
{
IsSingleInstance = "Yes"
OneDriveStorageQuota = "1024"
ExcludedFileExtensions = @("pst")
DomainGuids = "786548dd-877b-4760-a749-6b1efbc1190a"
GrooveBlockOption = "OptOut"
DisableReportProblemDialog = $true
BlockMacSync = $true
OrphanedPersonalSitesRetentionPeriod = "45"
OneDriveForGuestsEnabled = $false
ODBAccessRequests = "On"
ODBMembersCanShare = "On"
NotifyOwnersWhenInvitationsAccepted = $false
NotificationsInOneDriveForBusinessEnabled = $false
Ensure = "Present"
Credential = $credsGlobalAdmin
}
}
}