en-US/about_SPWorkflowService.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.NAME
    SPWorkflowService

# Description
    
    **Type:** Distributed
    
    This resource is used to register the SharePoint Server
    against a Workflow Manager Instance.
    
    Requirements:
    Provide the url of the Workflow Manager instance to
    connect to.
    
.PARAMETER WorkflowHostUri
    Key - string
    The URL of the Workflow Service

.PARAMETER SPSiteUrl
    Key - String
    The URL of the Site Collection to associate with the Workflow Service Proxy

.PARAMETER AllowOAuthHttp
    Write - Boolean
    Specify whether or not to allow connection to the Workflow Service over Http

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example registers the workflow service over http.


    Configuration Example
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPWorkflowService WorkflowService
            {
                WorkflowHostUri      = "http://workflow.sharepoint.contoso.com"
                SPSiteUrl            = "http://sites.sharepoint.com"
                AllowOAuthHttp       = $true
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }