Create SPOHomeSite.md

SPOHomeSite.md

@@ -0,0 +1,53 @@
+# SPOHomeSite
+
+## Parameters
+
+| Parameter | Attribute | DataType | Description | Allowed Values |
+| --- | --- | --- | --- | --- |
+| **IsSingleInstance** | Key | String | Specifies the resource is a single instance, the value must be 'Yes' |Yes|
+| **Url** | Write | String | The URL of the home site collection ||
+| **Ensure** | Write | String | Present ensures the site collection is registered as home site, absent ensures it is unregistered |Present, Absent|
+| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
+
+## Description
+
+This resource allows administrators to configure a Site Collection as the Home
+Site of the tenant. The menu of this SharePoint Site Collection will be shown on
+SharePoint Home.
+
+> NOTE:
+> This setting is not applied immediately and can take several hours to be fully
+> available within the tenant. Please use this resource with caution, as a direct
+> test run can lead to incorrect status results.
+> For more details about setting the home site, go to> aka.ms/homesites
+
+## 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.
+
+```powershell
+Configuration Example
+{
+    param(
+        [Parameter(Mandatory = $true)]
+        [PSCredential]
+        $credsGlobalAdmin
+    )
+    Import-DscResource -ModuleName Office365DSC
+
+    node localhost
+    {
+        SPOHomeSite "SetMarketingSiteCollectionAsHomeSite"
+        {
+            IsSingleInstance     = "Yes"
+            Url                  = "https://office365dsc.sharepoint.com/sites/Marketing"
+            Ensure               = "Present"
+            GlobalAdminAccount   = $credsGlobalAdmin
+        }
+    }
+}
+```
+