Storefront Powershell SDK 2411

Add-STFHmacKey

Add a named HMAC key stored to a web service.

Syntax

Add-STFHmacKey [-WebService] <StoreFrontWebService> [-Name] <String> [[-Key] <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Add a new named HMAC key stored to a web service.

Parameters

Name Description Required? Pipeline Input Default Value
WebService The Web Service to add the HMAC key to. true true (ByValue)  
Name The name of the HMAC key. true true (ByValue)  
Key The optional value of the HMAC key (Base64 encoded). If not specified then a new random value will be generated. false true (ByValue)  

Input Type

Citrix.StoreFront.Model.StoreFrontWebService

Parameter WebService: The .NET Citrix.StoreFront.Model.StoreFrontWebService reference type

System.String

Parameter Name: The .NET System.String reference type

System.String

Parameter Key: The .NET System.String reference type

Return Values

None

Examples

EXAMPLE 1 Add a new HMAC key named ‘test’ into the specified Store service, with the specified key.

$store = $store = Get-STFStoreService -VirtualPath '/Citrix/Store'
Add-STFHmacKey -WebService $store -Name 'test' -Key '6UA064hC8Dx/5/s0irY3Vc+tYUh2d6TqPMjC4Qy1NTtCwusyA39mXJTXXPuLaLI7x2wDhFDrsk0rqSqzjlV5Pw=='
<!--NeedCopy-->

REMARKS

Add the new HMAC key named ‘test’ into the specified Store service, with the specified key.

EXAMPLE 2 Add a new HMAC key named ‘test’ into the specified Store service, with a randomly generated key.

$store = $store = Get-STFStoreService -VirtualPath '/Citrix/Store'
Add-STFHmacKey -WebService $store -Name 'test'
<!--NeedCopy-->

REMARKS

Add the new HMAC key named ‘test’ into the specified Store service, with a randomly generated key.

Add-STFHmacKey