.png)
New-SPAccessServicesApplication
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise
Creates a new instance of an Access Services application in SharePoint Server 2013.
New-SPAccessServicesApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-Confirm [<SwitchParameter>]] [-Default <SwitchParameter>] [-Hosted <$true | $false>] [-Name <String>] [-PrivateBytesMax <Int32>] [-QueryTimeout <Int32>] [-RequestDurationMax <Int32>] [-SessionsPerAnonymousUserMax <Int32>] [-SessionsPerUserMax <Int32>] [-WhatIf [<SwitchParameter>]]
New-SPAccessServicesApplication -ApplicationPool <SPIisWebServiceApplicationPoolPipeBind> -DatabaseServer <String> -Default <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeout <Int32>] [-Confirm [<SwitchParameter>]] [-DatabaseServerCredentials <PSCredential>] [-Encrypt <$true | $false>] [-Hosted <$true | $false>] [-Name <String>] [-PrivateBytesMax <Int32>] [-QueryTimeout <Int32>] [-RequestDurationMax <Int32>] [-SessionsPerAnonymousUserMax <Int32>] [-SessionsPerUserMax <Int32>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the existing Internet Information Services (IIS) application pool to run the Web service in for the new Access Services application. The value must be a valid instance of a SPIisWebServiceApplicationPool object. | ||
| Default | Required | System.Management.Automation.SwitchParameter | Specifies that the service application is associated with web applications by adding this service application’s proxy to the farm’s default proxy list. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| CacheTimeout | Optional | System.Int32 | Specifies the number of seconds that a data cache will remain active on Access Services with no user activity. Valid values include: -1, cache never times out; 1 to 2073600, cache remains active from 1 second to 24 days. The value must be the integers -1, or an integer in the range of 1 to 2073600 (24 days). The default value is 300. | ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| Hosted | Optional | System.Boolean | Specifies that the Access Services application is used in a hosted environment that includes management of logical servers. The default value is false. | ||
| Name | Optional | System.String | Specifies the display name of the Access Services application to create. The name can contain a maximum of 128 characters and can contain the comma (,), equal sign (=), or colon (:) characters if they are enclosed in quotation marks. The type must be a valid name of an Access Services application; for example, AccessSrvApp1. | ||
| PrivateBytesMax | Optional | System.Int32 | Specifies the maximum private bytes in megabytes (MB) that can be used by Access Services. When set to -1, Access Services defaults to 75 percent of physical memory on the server. Valid values are -1 (no limit), and from 1 to any positive integer.The default value is -1. | ||
| QueryTimeout | Optional | System.Int32 | <Need description> | ||
| RequestDurationMax | Optional | System.Int32 | Specifies the maximum number of seconds that a request to perform an operation can use before the request times out. Valid values include: -1, no limit, 1 to 2073600, cache remains active 1 second to 24 days. The default value is 30. The value must be the integer -1, or an integer in the range of 1 to 2073600 (24 days) | ||
| SessionsPerAnonymousUserMax | Optional | System.Int32 | Specifies the maximum number of sessions allowed per user. If this maximum is exceeded, the oldest session is deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 10. The value must be the integer -1, or an integer in the range of 1 to MaxInt. | ||
| SessionsPerUserMax | Optional | System.Int32 | Specifies the maximum number of sessions allowed per user. If this maximum is exceeded, the oldest session is deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 10. The value must be the integer -1, or an integer in the range of 1 to MaxInt. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Note: | Parameter | Required | Type | Description | ||
| ApplicationPool | Required | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the existing Internet Information Services (IIS) application pool to run the Web service in for the new Access Services application. The value must be a valid instance of a SPIisWebServiceApplicationPool object. | ||
| DatabaseServer | Required | System.String | <Need description> | ||
| Default | Required | System.Management.Automation.SwitchParameter | Specifies that the service application is associated with web applications by adding this service application’s proxy to the farm’s default proxy list. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| CacheTimeout | Optional | System.Int32 | Specifies the number of seconds that a data cache will remain active on Access Services with no user activity. Valid values include: -1, cache never times out; 1 to 2073600, cache remains active from 1 second to 24 days. The value must be the integers -1, or an integer in the range of 1 to 2073600 (24 days). The default value is 300. | ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| DatabaseServerCredentials | Optional | System.Management.Automation.PSCredential | Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If no database credentials are provided, Windows authentication is used. | ||
| Encrypt | Optional | System.Boolean | <Need description> | ||
| Hosted | Optional | System.Boolean | Specifies that the Access Services application is used in a hosted environment that includes management of logical servers. The default value is false. | ||
| Name | Optional | System.String | Specifies the display name of the Access Services application to create. The name can contain a maximum of 128 characters and can contain the comma (,), equal sign (=), or colon (:) characters if they are enclosed in quotation marks. The type must be a valid name of an Access Services application; for example, AccessSrvApp1. | ||
| PrivateBytesMax | Optional | System.Int32 | Specifies the maximum private bytes in megabytes (MB) that can be used by Access Services. When set to -1, Access Services defaults to 75 percent of physical memory on the server. Valid values are -1 (no limit), and from 1 to any positive integer.The default value is -1. | ||
| QueryTimeout | Optional | System.Int32 | <Need description> | ||
| RequestDurationMax | Optional | System.Int32 | Specifies the maximum number of seconds that a request to perform an operation can use before the request times out. Valid values include: -1, no limit, 1 to 2073600, cache remains active 1 second to 24 days. The default value is 30. The value must be the integer -1, or an integer in the range of 1 to 2073600 (24 days) | ||
| SessionsPerAnonymousUserMax | Optional | System.Int32 | Specifies the maximum number of sessions allowed per user. If this maximum is exceeded, the oldest session is deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 10. The value must be the integer -1, or an integer in the range of 1 to MaxInt. | ||
| SessionsPerUserMax | Optional | System.Int32 | Specifies the maximum number of sessions allowed per user. If this maximum is exceeded, the oldest session is deleted when a new session is started. Valid values include: -1, no limit, and 1 to any positive integer. The default value is 10. The value must be the integer -1, or an integer in the range of 1 to MaxInt. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.
The New-SPAccessServiceApplication cmdlet creates a new instance of an Access Services application in SharePoint Server 2013. After you create a new Access Services application, use the Set-SPAccessServiceApplication cmdlet to modify its global settings.
Input Types
Return Types
-----------EXAMPLE--------
$serviceAppName = "Access Services"
$onPremAppPool = "on-prem-pool"
$sqlServerName = “SQLServer2012AppDbServer”
$ApplicationPool = Get-SPServiceApplicationPool –Identity $onPremAppPool
New-SPAccessServicesApplication -Name $serviceAppName -ApplicationPool $ApplicationPool -Default -DatabaseServer $sqlServerName
This example creates a new Access Services services application named Access Services
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
