Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Key	Key	String	The key of the storage entity.
EntityScope	Write	String	Scope of the storage entity.	Tenant, Site
Value	Write	String	Value of the storage entity.
Description	Write	String	Description of storage entity.
Comment	Write	String	Comment for the storage entity.
Ensure	Write	String	Used to add or remove storage entity.	Present, Absent
SiteUrl	Required	String	The url of site collection or tenant.
Credential	Write	PSCredential	Credentials of the Office365 Tenant Admin.
ApplicationId	Write	String	Id of the Azure Active Directory application to authenticate with.
ApplicationSecret	Write	String	Secret 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.

SPOStorageEntity

Description

This resource configures Storage Entity for SharePoint Online.

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
    {
        SPOStorageEntity MyStorageEntity
        {
            Key                = "DSCKey"
            Value              = "Test storage entity"
            EntityScope        = "Tenant"
            Description        = "Description created by DSC"
            Comment            = "Comment from DSC"
            Ensure             = "Present"
            SiteUrl            = "https://o365dsc1-admin.sharepoint.com"
            Credential         = $credsGlobalAdmin
        }
    }
}

Home
What is Microsoft365DSC?
Getting Started
Resources List and Examples