Set-STFStoreServiceExternalEndpoint

Last published : Oct 31, 2026
Set an external endpoint associated with the Store

Syntax

Set-STFStoreServiceExternalEndpoint [-StoreService] <StoreService> [-Id] <String> [-Url] <Uri> [-Capabilities] <String[]> [<CommonParameters>]

Detailed Description

Set an external endpoint associated with the Store, will override existing and create if a record for that ID does not exist.

Parameters

Name Description Required? Pipeline Input Default Value
StoreService Store service true true (ByValue)
Id The name of the endpoint to be added to the Store. true false
Url The URL to be added to the Store. true false
Capabilities The capabilities to be added to the Store for the URL. 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 Id: The .NET System.String reference type

System.Uri

Parameter Url: The .NET System.Uri reference type

System.String

Parameter Capabilities: The .NET System.String reference type

Return Values

None

Examples

EXAMPLE 1 Add an external endpoint

$store = Get-STFStoreService
            Set-STFStoreServiceExternalEndpoint -StoreService $store -Id ExternalEndpoint -Url 'https://external.url.com' -Capabilities @('Capability1', 'Capability2')
REMARKS
Add an external endpoint