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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
.NAME
    SPWorkflowService

# Description
    
    **Type:** Distributed
    **Requires CredSSP:** No
    
    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.
    Scope name is optional and defaults to SharePoint.
    If scope name is not specified any configured scope name is
    allowed by this resource.
    
    Remarks
    
    Change or configuration drift for AllowOAuthHttp is not detected
    by this resource.
    
.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 ScopeName
    Write - String
    Specify scope name. If not specified SharePoint will use the default scope name 'SharePoint'

.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
            }
        }
    }


.EXAMPLE
    This example registers the workflow service specifying a custom scope name.


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

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