Update documentation

dsccommunity · Nov 8, 2018 · 2c1a0e4 · 2c1a0e4
1 parent aaa9664
commit 2c1a0e4
Show file tree

Hide file tree

Showing 117 changed files with 830 additions and 280 deletions.
diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is responsible for creating Access Services Application instances
     within the local SharePoint farm. The resource will provision and configure the

diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt
@@ -0,0 +1,33 @@
+.NAME
+    SPAccessServices2010
+
+# Description
+
+    **Type:** Distributed
+    **Requires CredSSP:** No
+
+    This resource is responsible for creating Access Services 2010 Application
+    instances within the local SharePoint farm. The resource will provision and
+    configure the Access Services 2010 Service Application.
+
+    The default value for the Ensure parameter is Present. When not specifying this
+    parameter, the service application is provisioned.
+
+.PARAMETER Name
+    Key - String
+    The name of the service application
+
+.PARAMETER ApplicationPool
+    Required - String
+    The name of the application pool to run the service app in
+
+.PARAMETER Ensure
+    Write - String
+    Allowed values: Present, Absent
+    Present ensures service app exists, absent ensures it is removed
+
+.PARAMETER InstallAccount
+    Write - String
+    POWERSHELL 4 ONLY: The account to run thsi resource as, use PsDscRunAsCredential if using PowerShell 5
+
+
diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is used to define an alternate access mapping URL for a specified
     web application. These can be assigned to specific zones for each web

diff --git a/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt
@@ -4,15 +4,21 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is used to set the global antivirus settings for the local farm.
     These settings will be used to control the behavior of an external anti-virus
     scanning tool that is able to integrate with SharePoint. Note that this will
     not scan documents for viruses on it's own, an external tool still needs to be
     installed on the servers that integrates with SharePoint.
 
+.PARAMETER IsSingleInstance
+    Key - String
+    Allowed values: Yes
+    Specifies the resource is a single instance, the value must be 'Yes'
+
 .PARAMETER ScanOnDownload
-    Key - Boolean
+    Write - Boolean
     Should documents be scanned before being downloaded
 
 .PARAMETER ScanOnUpload
@@ -44,7 +50,7 @@
     This example shows how to apply specific anti-virus configuration to the farm
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -56,6 +62,7 @@
         node localhost {
             SPAntivirusSettings AVSettings
             {
+                IsSingleInstance      = "Yes"
                 ScanOnDownload        = $true
                 ScanOnUpload          = $true
                 AllowDownloadInfected = $false

diff --git a/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** Yes
 
     This resource will ensure that a specific site collection is marked as the app
     catalog for the web application that the site is in. The catalog site needs to

diff --git a/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource will set the value for the app domain settings at the farm level.
     You can set the domain name and the prefix that is to be used for app URLs.

diff --git a/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is used to provision and manage an instance of the App Management
     Services Service Application. It will identify an instance of the app

diff --git a/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource will configure the ability to purchase apps for both SharePoint
     and Office apps.

diff --git a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is used to provision and manage an instance of the Business
     Connectivity Services Service Application. It will identify an instance

diff --git a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Specific
+    **Requires CredSSP:** No
 
     This resource is used to configure the Blob Cache settings for a web
     application.

diff --git a/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt b/Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is used to set the "super user" and "super reader" cache accounts
     for the specified web application object (as described in the TechNet article

diff --git a/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt b/Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt
@@ -4,17 +4,23 @@
 # Description
 
     **Type:** Utility
+    **Requires CredSSP:** No
 
     This resource is used to perform the upgrade step of installing SharePoint
     updates, like Cumulative Updates, Service Packs and Language Packs. The
     DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in
     which the update can be installed. This module has to be used to complete the
     update installation step, performed by SPProductUpdate.
 
+.PARAMETER IsSingleInstance
+    Key - String
+    Allowed values: Yes
+    Specifies the resource is a single instance, the value must be 'Yes'
+
 .PARAMETER Ensure
-    Key - string
+    Write - string
     Allowed values: Present, Absent
-    Present to install SharePoint. Absent is currently not supported
+    Present to run the Configuration Wizard. Absent is currently not supported
 
 .PARAMETER DatabaseUpgradeDays
     Write - String
@@ -34,7 +40,7 @@
     This example runs the Configuration Wizard as soon as it is applied.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -46,7 +52,7 @@
         node localhost {
             SPConfigWizard RunConfigWizard
             {
-                Ensure               = "Present"
+                IsSingleInstance     = "Yes"
                 PsDscRunAsCredential = $SetupAccount
             }
         }
@@ -58,7 +64,7 @@
     - Saturday and Sunday night between 3am and 5am.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -70,7 +76,7 @@
         node localhost {
             SPConfigWizard RunConfigWizard
             {
-                Ensure               = "Present"
+                IsSingleInstance     = "Yes"
                 DatabaseUpgradeDays  = "sat", "sun"
                 DatabaseUpgradeTime  = "3:00am to 5:00am"
                 PsDscRunAsCredential = $SetupAccount

diff --git a/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt b/Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is used to add and remove Content Databases to web applications
     and configure these databases.

diff --git a/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPCreateFarm.help.txt
diff --git a/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt b/Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource will allow specifying which SQL Server AlwaysOn Availability
     group a resource should be in. This resource does not configure the

diff --git a/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is used to set the SharePoint Designer settings for the local
     farm or site collections. These settings will be used to control if users are
@@ -22,7 +23,7 @@
     changing the Site Collection settings results in an Access Denied error.
     Consider implementing PowerShell v5 and switching to the PsDscRunAsCredential
 
-.PARAMETER Url
+.PARAMETER WebAppUrl
     Key - string
     The URL of the web application or site collection to configure
 
@@ -65,11 +66,11 @@
 
 
 .EXAMPLE
-    This example applies settings to disable SharePoint Designer access to the 
+    This example applies settings to disable SharePoint Designer access to the
     specified web application.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -81,7 +82,7 @@
         node localhost {
             SPDesignerSettings MainWebAppSPDSettings
             {
-                Url                                     = "https://intranet.sharepoint.contoso.com"
+                WebAppUrl                               = "https://intranet.sharepoint.contoso.com"
                 SettingsScope                           = "WebApplication"
                 AllowSharePointDesigner                 = $false
                 AllowDetachPagesFromDefinition          = $false

diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticLoggingSettings.help.txt
@@ -4,14 +4,20 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is responsible for configuring settings to do with the diagnostic
     (ULS) logging on servers in the farm. These settings are applied to the
     diagnostic logging service for the farm and do not need to be applied to each
     server individually, the settings will be propagated throughout the farm when
 
+.PARAMETER IsSingleInstance
+    Key - String
+    Allowed values: Yes
+    Specifies the resource is a single instance, the value must be 'Yes'
+
 .PARAMETER LogPath
-    Key - string
+    Required - string
     The physical path on each server to store ULS logs
 
 .PARAMETER LogSpaceInGB
@@ -93,7 +99,7 @@
     whatever value has been manually configured outside of DSC.
 
 
-    Configuration Example 
+    Configuration Example
     {
         param(
             [Parameter(Mandatory = $true)]
@@ -105,7 +111,7 @@
         node localhost {
             SPDiagnosticLoggingSettings ApplyDiagnosticLogSettings
             {
-                PsDscRunAsCredential                        = $SetupAccount
+                IsSingleInstance                            = "Yes"
                 LogPath                                     = "L:\ULSLogs"
                 LogSpaceInGB                                = 10
                 AppAnalyticsAutomaticUploadEnabled          = $false
@@ -124,6 +130,7 @@
                 ScriptErrorReportingDelay                   = 30
                 ScriptErrorReportingEnabled                 = $true
                 ScriptErrorReportingRequireAuth             = $true
+                PsDscRunAsCredential                        = $SetupAccount
             }
         }
     }

diff --git a/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt b/Modules/SharePointDsc/en-US/about_SPDiagnosticsProvider.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is responsible for configuring the Diagnostics Provider within
     the local SharePoint farm. Using Ensure equals to Absent is not supported.

diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is responsible for configuring the distributed cache client
     settings. It only accepts Ensure='Present' as a key. The resource can

diff --git a/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt b/Modules/SharePointDsc/en-US/about_SPDistributedCacheService.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Specific
+    **Requires CredSSP:** No
 
     This resource is responsible for provisioning the distributed cache to the
     service it runs on. This is required in your farm on at least one server (as

diff --git a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt
@@ -4,6 +4,7 @@
 # Description
 
     **Type:** Distributed
+    **Requires CredSSP:** No
 
     This resource is responsible for creating Excel Services Application instances
     within the local SharePoint farm. The resource will provision and configure the