en-US/about_SPBCSServiceApp.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
97
98
99
100
101
102
103
104
.NAME
    SPBCSServiceApp

# 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
    will provision the app if it does not yet exist, and will change the service
    account associated to the app if it does not match the configuration. Database
    names or server name will not be changed if the configuration does not match,
    these parameters are only used for the initial provisioning of the 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 BCS service app

.PARAMETER ProxyName
    Write - string
    The name of the BCS service application proxy

.PARAMETER ApplicationPool
    Required - String
    The application pool it should run in

.PARAMETER DatabaseName
    Write - string
    Name of the database to create for the service app

.PARAMETER DatabaseServer
    Write - String
    Name of the database server to host the database on

.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 this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    This example shows how to deploy a Business Connectivity Services application to the
    local SharePoint farm. 


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

        node localhost {
            SPBCSServiceApp BCSServiceApp
            {
                Name            = "BCS Service Application"
                ApplicationPool = "SharePoint Service Applications"
                DatabaseName    = "SP_BCS"
                DatabaseServer  = "SQL.contoso.local\SQLINSTANCE"
                InstallAccount  = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to deploy a Business Connectivity Services application to the
    local SharePoint farm. The application pool account is mandatory but the value is 
    ignored when removing a service app, so the value entered here does not matter. 


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

        node localhost {
            SPBCSServiceApp BCSServiceApp
            {
                Name                 = "BCS Service Application"
                ApplicationPool      = "n/a"
                Ensure               = "Absent"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }