Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ykuijs committed Jun 13, 2018
1 parent 85e801e commit 44dd807
Showing 106 changed files with 433 additions and 2 deletions.
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is responsible for creating Access Services Application instances
within the local SharePoint farm. The resource will provision and configure the
Access Services Service Application.
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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
application. Alternatively a URL can be removed from a zone to ensure that it
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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
have been created using the correct template (APPCATALOG#0).
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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.

Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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
management service application through the application display name. Currently
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource will configure the ability to purchase apps for both SharePoint
and Office apps.

2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to provision and manage an instance of the Business
Connectivity Services Service Application. It will identify an instance
of the BCS app through the application display name. Currently the resource
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Specific

This resource is used to configure the Blob Cache settings for a web
application.

2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPCacheAccounts.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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
[Configure object cache user accounts in SharePoint Server 2013](https://technet.microsoft.com/en-us/library/ff758656.aspx)).
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPConfigWizard.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Utility

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
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPContentDatabase.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to add and remove Content Databases to web applications
and configure these databases.

2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPDatabaseAAG.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource will allow specifying which SQL Server AlwaysOn Availability
group a resource should be in. This resource does not configure the
Availability Groups on SQL Server, they must already exist. It simply adds
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPDesignerSettings.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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
allowed to make changes using SharePoint Designer. Note that this will not
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

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
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is responsible for configuring the Diagnostics Provider within
the local SharePoint farm. Using Ensure equals to Absent is not supported.
This resource can only apply configuration, not ensure they don't exist.
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is responsible for configuring the distributed cache client
settings. It only accepts Ensure='Present' as a key. The resource can
configure the following cache components: DistributedLogonTokenCache,
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Specific

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
the behavior of SPCreateFarm and SPJoinFarm is to not enroll every server as a
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is responsible for creating Excel Services Application instances
within the local SharePoint farm. The resource will provision and configure the
Excel Services Service Application.
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPFarm.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Specific

This resource is used to create a new SharePoint farm and allow servers to
join that farm. It will detect the presence of the configuration database
on the SQL server as a first step, and if it does not exist then the farm
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Common

This resource is used to manage the membership of the farm administrators
group. There are a number of approaches to how this can be implemented. The
"members" property will set a specific list of members for the group, making
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPFarmPropertyBag.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to work with SharePoint Property Bags at the farm level.
The account that runs this resource must be a farm administrator.

2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPFarmSolution.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to make sure that a specific farm solution is either
present or absent in a farm. The solution can be deployed to one or more web
application passing an array of URL's to the WebApplications property. If the
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPFeature.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to make sure that a specific feature is either enabled
or disabled at a given URL/scope. The Ensure property will dictate if the
feature should be on or off. The name property is the name of the feature
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to configure Health Analyzer rules for the local farm.
The resource is able to enable/disable and configure the specified rule.

Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is responsible for configuring the InfoPath Forms service within
the local SharePoint farm. Using Ensure equals to Absent is not supported.
This resource can only apply configuration, not ensure they don't exist.
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPInstall.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Common

This resource is used to install the SharePoint binaries. The BinaryDir
parameter should point to the path that setup.exe is located (not to setup.exe
itself). The ProductKey parameter is used to inject in to the configuration
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to install the SharePoint Language Pack binaries. The
BinaryDir parameter should point to the path that setup.exe is located (not to
setup.exe itself).
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPInstallPrereqs.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Common

This resource is responsible for ensuring the installation of all SharePoint
prerequisites. It makes use of the PrerequisiteInstaller.exe file that is part
of the SharePoint binaries, and will install the required Windows features as
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPIrmSettings.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to manipulate the IRM settings in SharePoint, integrating
it with AD RMS

2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPLogLevel.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to change the minimum severity of events captured in
the trace logs (ULS logs) and the Windows event logs. Settings can be changed
globally for all areas and categories (using the '*' character as the
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to provision and manage an instance of the Machine
Translation Service Application. It will identify an instance of the MT
app through the application display name. Currently the resource will
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPManagedAccount.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource will ensure a managed account is provisioned in to the SharePoint
farm. The Account object specific the credential to store (including username
and password) to set as the managed account. The settings for
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

Creates a managed metadata service application. The application pool property
specifies which application pool it should use, and will reset the application
back to this pool if it is changed after its initial provisioning. The
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

Using several managed metadata service instances in a farm requires some
configuration, which service application proxy should be used as default
for keywords or site collection specific term sets.
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPManagedPath.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is responsible for creating managed paths associated with a
specific web application. The WebAppUrl parameter is used to specify the web
application to create the path against, and the RelativeUrl parameter lets you
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Utility

This resource will help manage compliance of MinRole based servers. Each time
the resource runs it will investigate which service instances should be running
based on the role of servers anywhere in the farm, and if they are not in a
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource will create a binding to an Office Online Server (formerly known
as Office Web Apps). The DnsName property can be a single server name, or a
FQDN of a load balanced end point that will direct traffic to a farm.
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to set the outgoing email settings for either a single
web application, or the whole farm. To configure the resource for a specific
web app, use the URL of the web application for the WebAppUrl property, to
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to control settings that relate to the automatic
changing of passwords for managed accounts (where they opt-in to be managed by
SharePoint). These settings can be manually controlled through central
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is responsible for creating Performance Point Service Application
instances within the local SharePoint farm. The resource will provision and
configure the Performance Point Service Application.
2 changes: 2 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Common

This resource is used to perform the update step of installing SharePoint
updates, like Cumulative Updates and Service Packs. The SetupFile parameter
should point to the update file. The ShutdownServices parameter is used to
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to control the settings of the Active Directory
resource pool sync for Project Server, for a specific PWA instance.
You can control which AD groups should be imported from and control
Original file line number Diff line number Diff line change
@@ -3,6 +3,8 @@

# Description

**Type:** Distributed

This resource is used to manage the "additional settings" for a PWA instance
(based on what is in the 'additional settings' page of the web interface).

Loading

0 comments on commit 44dd807

Please sign in to comment.