Edit

Share via


Set-SPAccessServicesApplication

Sets the properties of a Access Services service application.

Syntax

Default (Default)

Set-SPAccessServicesApplication
    [-Identity] <SPServiceApplicationPipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-CacheTimeout <Int32>]
    [-Confirm]
    [-PrivateBytesMax <Int32>]
    [-RecoveryPointObjective <Int32>]
    [-RequestDurationMax <Int32>]
    [-SessionsPerAnonymousUserMax <Int32>]
    [-SessionsPerUserMax <Int32>]
    [-WhatIf]
    [<CommonParameters>]

Description

Use the Set-SPAccessServicesApplication cmdlet to set the properties of an Access Services service application.

Examples

EXAMPLE

$sa = Get-SPAccessServicesApplication
Set-SPAccessServicesApplication -Identity $sa -SessionsPerUserMax 50

Sets the maximum number of sessions per user to 50.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-CacheTimeout

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Sets the cache timeout value in seconds. The default is 300.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the Access Service service application to update.

The type must be a valid GUID or the name of a valid managed metadata service application.

Parameter properties

Type:SPServiceApplicationPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivateBytesMax

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Sets the maximum private bytes that can be used by Access Services. The default value is -1 (no limit).

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RecoveryPointObjective

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Not used.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestDurationMax

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Sets the timeout value for requests in seconds. Default is 30.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SessionsPerAnonymousUserMax

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Sets the number of sessions per anonymous user. The default is 25.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SessionsPerUserMax

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Sets the number of sessions per user. The default is 10.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object