Citrix StoreFront SDK PowerShell Modules


Sets the location of the subscription data storage for the specified Store


Set-STFStoreSubscriptionsDatabase [-ConnectionString] <String> [-StoreService] <StoreService> [<CommonParameters>]

Set-STFStoreSubscriptionsDatabase [-UseLocalStorage] <SwitchParameter> [-StoreService] <StoreService> [<CommonParameters>]

Set-STFStoreSubscriptionsDatabase [-UseDocumentDbStorage] <SwitchParameter> [-StoreService] <StoreService> [<CommonParameters>]

Detailed Description

Sets the connection string for the SQL Server database currently used for subscription data for the specified Store.


Name Description Required? Pipeline Input Default Value
StoreService The Store service to set the subscriptions storage for true true (ByValue)  
ConnectionString The connection string for a SQL Server database which should be used for subscription data storage true false  
UseLocalStorage Specifies that the Store should use StoreFront’s default local storage. Local storage is created and managed automatically across all members of the server group true false  
UseDocumentDbStorage Specifies that the Store should use DocumentDb storage. The access credentials the the DocumentDb database are included in the store configuration already, not relevent to on premise deployments true false  

Input Type


Parameter StoreService: A .NET class representing the configuration of a StoreFront Store service


Parameter ConnectionString: The .NET System.String reference type


Parameter UseLocalStorage: The .NET System.Management.Automation.SwitchParameter value type


Parameter UseDocumentDbStorage: The .NET System.Management.Automation.SwitchParameter value type

Return Values



EXAMPLE 1 Configure Sql database connection

$store = Get-STFStoreService
Set-STFStoreStoreSubscriptionsDatabase -StoreService $store -ConnectionString 'Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;'


Configure the store to use a SQL Server database for subscription data storage.

The connection string in this example specifies the server name, instance name and

database name of the SQL Server database and that StoreFront should using Windows

integrated authentication.The connection string format for SQL Server databases is

described in detail in SQL Server documentation.