about_SPBCSServiceApp
3par-powershell
activedirectory
activedirectory_filter
activedirectory_identity
activedirectory_objectmodel
activitycommonparameters
aliases
arithmetic_operators
arrays
assignment_operators
automatic_variables
beforeeach_aftereach
binshred
break
carbon
carbon_2.0
carbon_contributing
carbon_extended_type_data
carbon_installation
carbon_support
ceip
checkpoint-workflow
cimsession
classes
command_precedence
command_syntax
comment_based_help
commonparameters
comparison_operators
configuration
continue
core_commands
data_sections
debuggers
desiredstateconfiguration
do
document
environment_variables
escape_characters
eventlogs
execution_policies
for
foreach-parallel
foreach
format.ps1xml
functions
functions_advanced
functions_advanced_methods
functions_advanced_parameters
functions_cmdletbindingattribute
functions_outputtypeattribute
group_policy_settings
hash_tables
history
if
inlinescript
invalid_certificates
job_details
jobs
join
language_keywords
language_modes
line_editing
locations
logical_operators
methods
mocking
modules
object_creation
objects
obn
operator_precedence
operators
packagemanagement
parallel
parameters
parameters_default_values
parsing
parsing_loctest
path_syntax
pester
pipelines
plaster.help
plaster_creatingamanifest.help
platyps
plugins
poshrsjob
powercli_objects
powershell.exe
powershell_ise.exe
powershelllogging
preference_variables
profiles
prompts
properties
providers
psconsolehostreadline
pscribo
pscx
psreadline
psscriptanalyzer
pssession_details
pssessions
pssnapins
psversioncompare
quoting_rules
redirection
ref
regular_expressions
remote
remote_disconnected_sessions
remote_faq
remote_jobs
remote_output
remote_requirements
remote_troubleshooting
remote_variables
requires
reserved_words
return
run_with_powershell
runasync
scheduled_jobs
scheduled_jobs_advanced
scheduled_jobs_basics
scheduled_jobs_troubleshooting
scopes
script_blocks
script_internationalization
scripts
sequence
server_authentication
session_configuration_files
session_configurations
should
signing
spaccessserviceapp
spalternateurl
spantivirussettings
spappcatalog
spappdomain
spappmanagementserviceapp
spappstoresettings
spbcsserviceapp
spblobcachesettings
spcacheaccounts
spconfigwizard
spcontentdatabase
spcreatefarm
spdatabaseaag
spdesignersettings
spdiagnosticloggingsettings
spdistributedcacheservice
special_characters
spexcelserviceapp
spfarmadministrators
spfarmsolution
spfeature
sphealthanalyzerrulestate
spinstall
spinstalllanguagepack
spinstallprereqs
spirmsettings
spjoinfarm
splatting
split
spmanagedaccount
spmanagedmetadataserviceapp
spmanagedpath
spofficeonlineserverbinding
spoutgoingemailsettings
sppasswordchangesettings
spperformancepointserviceapp
spproductupdate
sppublishserviceapplication
spquotatemplate
spremotefarmtrust
spsearchcontentsource
spsearchcrawlrule
spsearchfiletype
spsearchindexpartition
spsearchresultsource
spsearchserviceapp
spsearchtopology
spsecurestoreserviceapp
spserviceapppool
spserviceappproxygroup
spserviceappsecurity
spserviceinstance
spsessionstateservice
spshelladmins
spsite
spstateserviceapp
spsubscriptionsettingsserviceapp
sptimerjobstate
sptrustedidentitytokenissuer
spusageapplication
spuserprofileproperty
spuserprofilesection
spuserprofileserviceapp
spuserprofileserviceapppermissions
spuserprofilesyncconnection
spuserprofilesyncservice
spvisioserviceapp
spweb
spwebappblockedfiletypes
spwebappgeneralsettings
spwebapplication
spwebapplicationappdomain
spwebapppermissions
spwebapppolicy
spwebappproxygroup
spwebappsiteuseanddeletion
spwebappthrottlingsettings
spwebappworkflowsettings
spwordautomationserviceapp
spworkmanagementserviceapp
suspend-workflow
switch
testdrive
throw
transactions
trap
try_catch_finally
type_operators
types.ps1xml
uid
updatable_help
variables
vimdatastore
while
wildcards
windows_powershell_5.0
windows_powershell_ise
windows_rt
wmi
wmi_cmdlets
workflowcommonparameters
workflows
wql
ws-management_cmdlets
activedirectory
activedirectory_filter
activedirectory_identity
activedirectory_objectmodel
activitycommonparameters
aliases
arithmetic_operators
arrays
assignment_operators
automatic_variables
beforeeach_aftereach
binshred
break
carbon
carbon_2.0
carbon_contributing
carbon_extended_type_data
carbon_installation
carbon_support
ceip
checkpoint-workflow
cimsession
classes
command_precedence
command_syntax
comment_based_help
commonparameters
comparison_operators
configuration
continue
core_commands
data_sections
debuggers
desiredstateconfiguration
do
document
environment_variables
escape_characters
eventlogs
execution_policies
for
foreach-parallel
foreach
format.ps1xml
functions
functions_advanced
functions_advanced_methods
functions_advanced_parameters
functions_cmdletbindingattribute
functions_outputtypeattribute
group_policy_settings
hash_tables
history
if
inlinescript
invalid_certificates
job_details
jobs
join
language_keywords
language_modes
line_editing
locations
logical_operators
methods
mocking
modules
object_creation
objects
obn
operator_precedence
operators
packagemanagement
parallel
parameters
parameters_default_values
parsing
parsing_loctest
path_syntax
pester
pipelines
plaster.help
plaster_creatingamanifest.help
platyps
plugins
poshrsjob
powercli_objects
powershell.exe
powershell_ise.exe
powershelllogging
preference_variables
profiles
prompts
properties
providers
psconsolehostreadline
pscribo
pscx
psreadline
psscriptanalyzer
pssession_details
pssessions
pssnapins
psversioncompare
quoting_rules
redirection
ref
regular_expressions
remote
remote_disconnected_sessions
remote_faq
remote_jobs
remote_output
remote_requirements
remote_troubleshooting
remote_variables
requires
reserved_words
return
run_with_powershell
runasync
scheduled_jobs
scheduled_jobs_advanced
scheduled_jobs_basics
scheduled_jobs_troubleshooting
scopes
script_blocks
script_internationalization
scripts
sequence
server_authentication
session_configuration_files
session_configurations
should
signing
spaccessserviceapp
spalternateurl
spantivirussettings
spappcatalog
spappdomain
spappmanagementserviceapp
spappstoresettings
spbcsserviceapp
spblobcachesettings
spcacheaccounts
spconfigwizard
spcontentdatabase
spcreatefarm
spdatabaseaag
spdesignersettings
spdiagnosticloggingsettings
spdistributedcacheservice
special_characters
spexcelserviceapp
spfarmadministrators
spfarmsolution
spfeature
sphealthanalyzerrulestate
spinstall
spinstalllanguagepack
spinstallprereqs
spirmsettings
spjoinfarm
splatting
split
spmanagedaccount
spmanagedmetadataserviceapp
spmanagedpath
spofficeonlineserverbinding
spoutgoingemailsettings
sppasswordchangesettings
spperformancepointserviceapp
spproductupdate
sppublishserviceapplication
spquotatemplate
spremotefarmtrust
spsearchcontentsource
spsearchcrawlrule
spsearchfiletype
spsearchindexpartition
spsearchresultsource
spsearchserviceapp
spsearchtopology
spsecurestoreserviceapp
spserviceapppool
spserviceappproxygroup
spserviceappsecurity
spserviceinstance
spsessionstateservice
spshelladmins
spsite
spstateserviceapp
spsubscriptionsettingsserviceapp
sptimerjobstate
sptrustedidentitytokenissuer
spusageapplication
spuserprofileproperty
spuserprofilesection
spuserprofileserviceapp
spuserprofileserviceapppermissions
spuserprofilesyncconnection
spuserprofilesyncservice
spvisioserviceapp
spweb
spwebappblockedfiletypes
spwebappgeneralsettings
spwebapplication
spwebapplicationappdomain
spwebapppermissions
spwebapppolicy
spwebappproxygroup
spwebappsiteuseanddeletion
spwebappthrottlingsettings
spwebappworkflowsettings
spwordautomationserviceapp
spworkmanagementserviceapp
suspend-workflow
switch
testdrive
throw
transactions
trap
try_catch_finally
type_operators
types.ps1xml
uid
updatable_help
variables
vimdatastore
while
wildcards
windows_powershell_5.0
windows_powershell_ise
windows_rt
wmi
wmi_cmdlets
workflowcommonparameters
workflows
wql
ws-management_cmdlets
Spbcsserviceapp
SharePointDSC
SHORT DESCRIPTION
.NAME
SPBCSServiceApp
# Description
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.
.PARAMETER Name
Key - string
The name of the BCS service app
.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
}
}
}