Citrix StoreFront SDK PowerShell Modules

Set-STFStoreSubscriptionsDatabase

March 5, 2024

Contributed by:

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

Syntax

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

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

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

Detailed Description

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

Get-STFStoreSubscriptionsDatabase

Parameters

Name	Description	Required?	Pipeline Input
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

Citrix.StoreFront.Model.Store.StoreService

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

System.String

Parameter ConnectionString: The .NET System.String reference type

System.Management.Automation.SwitchParameter

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

System.Management.Automation.SwitchParameter

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

Return Values

None

Examples

EXAMPLE 1 Configure Sql database connection

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

REMARKS

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-STFStoreSubscriptionsDatabase

March 5, 2024

Contributed by:

March 5, 2024

Contributed by:

Set-STFStoreSubscriptionsDatabase

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.Store.StoreService

System.String

System.Management.Automation.SwitchParameter

System.Management.Automation.SwitchParameter

Return Values

None

Examples

EXAMPLE 1 Configure Sql database connection

In this article