From 2ff8c849eb79eed7818e502a6a4fc99010e009d7 Mon Sep 17 00:00:00 2001 From: Yorick Kuijs Date: Mon, 24 Jun 2019 11:35:23 +0200 Subject: [PATCH] Updated help files --- .../en-US/about_SPExcelServiceApp.help.txt | 4 +- .../SharePointDsc/en-US/about_SPFarm.help.txt | 5 +- .../en-US/about_SPProductUpdate.help.txt | 12 ++- .../about_SPWebAppAuthentication.help.txt | 75 ++++++++++++++----- 4 files changed, 66 insertions(+), 30 deletions(-) diff --git a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt index 4c38fc440..c31ff6438 100644 --- a/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPExcelServiceApp.help.txt @@ -57,7 +57,7 @@ Specifies the percentage of the maximum private bytes that can be allocated to inactive objects. .PARAMETER PrivateBytesMax - Write - Uint32 + Write - Sint32 Specifies the maximum private bytes, in megabytes, that are used by Excel Services Application. .PARAMETER SessionsPerUserMax @@ -81,7 +81,7 @@ Specifies that the application ID that is used to look up the unattended service account credentials from the secure storage service that is specified by the UnattendedAccountSecureServiceAppName parameter. .PARAMETER UnusedObjectAgeMax - Write - Uint32 + Write - Sint32 Specifies the maximum amount of time, in minutes, that objects not currently used in a session are kept in the memory cache. .PARAMETER WorkbookCache diff --git a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt index 909404e5b..887937e52 100644 --- a/Modules/SharePointDsc/en-US/about_SPFarm.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPFarm.help.txt @@ -42,7 +42,8 @@ To provision Central Admin as an SSL web application, specify a value for the CentralAdministrationUrl property that begins with https:// followed by the vanity host name or server name you wish to use to access CA. - (e.g. https://admin.sharepoint.contoso.com). + (e.g. https://admin.sharepoint.contoso.com). This parameter does not + currently support HTTP. DeveloperDashboard can be specified as "On", "Off" and (only when using SharePoint 2013) to "OnDemand". @@ -88,7 +89,7 @@ .PARAMETER CentralAdministrationUrl Write - String - Vanity URL for Central Administration to be used with SSL + Vanity URL for Central Administration (currently HTTPS only). For HTTP vanity host, use SPAlternateHost. .PARAMETER CentralAdministrationPort Write - Uint32 diff --git a/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt index 079a04c75..a40d454d9 100644 --- a/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPProductUpdate.help.txt @@ -23,17 +23,15 @@ SPProductUpdate will throw an error when it detects the file is blocked. IMPORTANT: - This resource retrieves build information from the Configuration Database. - Therefore it requires SharePoint to be installed and a farm created. If you - like to deploy a new farm and install updates automatically, you need to - implement the following order: + Since v3.3, this resource no longer relies on the farm being present to check + the installed patches. This means it is now possible to deploy updates during + the installation of SharePoint: 1. Install the SharePoint Binaries (SPInstall) 2. (Optional) Install SharePoint Language Pack(s) Binaries (SPInstallLanguagePack) - 3. Create SPFarm (SPFarm) - 4. Install Cumulative Updates (SPProductUpdate) - 5. Run the Configuration Wizard (SPConfigWizard) + 3. Install Cumulative Updates (SPProductUpdate) + 4. Create SPFarm (SPFarm) .PARAMETER SetupFile Key - String diff --git a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt index 2ee0cff66..1c90344ab 100644 --- a/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt +++ b/Modules/SharePointDsc/en-US/about_SPWebAppAuthentication.help.txt @@ -15,6 +15,8 @@ This resource cannot be used to convert a Classic web application to Claims mode. You have to run Convert-SPWebApplication manually for that. + For Classic web applications, you have to use AuthenticationMethod="Classic". + NOTE 2: Updating the configuration can take a long time, up to five minutes. The Set-SPWebApplication cmdlet sometimes requires several minutes to @@ -58,30 +60,33 @@ Configuration Example { - param( + param + ( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) + Import-DscResource -ModuleName SharePointDsc node localhost { SPWebAppAuthentication ContosoAuthentication { - WebAppUrl = "http://sharepoint.contoso.com" - Default = @( + WebAppUrl = "http://sharepoint.contoso.com" + Default = @( MSFT_SPWebAppAuthenticationMode { AuthenticationMethod = "NTLM" } ) - Extranet = @( + Extranet = @( MSFT_SPWebAppAuthenticationMode { AuthenticationMethod = "FBA" - MembershipProvider = "MemberPRovider" - RoleProvider = "RoleProvider" + MembershipProvider = "MemberPRovider" + RoleProvider = "RoleProvider" } ) + PsDscRunAsCredential = $SetupAccount } } } @@ -96,16 +101,16 @@ Configuration Example { - param( + param + ( [Parameter(Mandatory = $true)] [PSCredential] $SetupAccount ) + Import-DscResource -ModuleName SharePointDsc node localhost { - - SPTrustedIdentityTokenIssuer SampleSPTrust { Name = "Contoso" @@ -114,14 +119,14 @@ SignInUrl = "https://adfs.contoso.com/adfs/ls/" IdentifierClaim = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" ClaimsMappings = @( - MSFT_SPClaimTypeMapping{ - Name = "Email" + MSFT_SPClaimTypeMapping { + Name = "Email" IncomingClaimType = "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" } - MSFT_SPClaimTypeMapping{ - Name = "Role" + MSFT_SPClaimTypeMapping { + Name = "Role" IncomingClaimType = "http://schemas.xmlsoap.org/ExternalSTSGroupType" - LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" + LocalClaimType = "http://schemas.microsoft.com/ws/2008/06/identity/claims/role" } ) SigningCertificateThumbPrint = "F3229E7CCA1DA812E29284B0ED75A9A019A83B08" @@ -131,22 +136,54 @@ PsDscRunAsCredential = $SetupAccount } - SPWebAppAuthentication ContosoAuthentication { - WebAppUrl = "http://sharepoint.contoso.com" - Default = @( + WebAppUrl = "http://sharepoint.contoso.com" + Default = @( MSFT_SPWebAppAuthenticationMode { AuthenticationMethod = "NTLM" } ) - Internet = @( + Internet = @( MSFT_SPWebAppAuthenticationMode { AuthenticationMethod = "Federated" AuthenticationProvider = "Contoso" } ) - DependsOn = "[SPTrustedIdentityTokenIssuer]SampleSPTrust" + PsDscRunAsCredential = $SetupAccount + DependsOn = "[SPTrustedIdentityTokenIssuer]SampleSPTrust" + } + } + } + + +.EXAMPLE + This example shows how to configure the authentication of a web application in the + local farm using Classic authentication. + + + Configuration Example + { + param + ( + [Parameter(Mandatory = $true)] + [PSCredential] + $SetupAccount + ) + + Import-DscResource -ModuleName SharePointDsc + + node localhost + { + SPWebAppAuthentication ContosoAuthentication + { + WebAppUrl = "http://sharepoint.contoso.com" + Default = @( + MSFT_SPWebAppAuthenticationMode { + AuthenticationMethod = "Classic" + } + ) + PsDscRunAsCredential = $SetupAccount } } }