Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-BrokerStorefrontAddress

August 3, 2023
Contributed by: 
C

Gets the high-level description of a configuration for StoreFront addresses, based on a configuration byte array.

Syntax


Get-BrokerStorefrontAddress [-ByteArray] <Byte[]> [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Use this command to convert a configuration byte array into a set of named property settings. The byte array will either have been retrieved from the Citrix Broker Service, or from the New-BrokerStorefrontAddress cmdlet.

Parameters

Name Description Required? Pipeline Input Default Value
ByteArray Specifies the low-level byte array (blob) to be interpreted. true true (ByValue)  

Input Type

System.Byte[]

The cmdlet accepts the ByteArray parameter as pipeline input.

Return Values

Citrix.Storefront.Sdk.Brokerstorefrontaddress

This cmdlet outputs one BrokerStorefrontAddress object for each address that is configured within the slot. Each object has the following properties: Name - Specifies the name of the StoreFront. Url - Specifies the URL to the StoreFront, such as “https://mysite.com/Citrix/StoreWeb”. Enabled - Specifies whether the StoreFront is enabled for users. Description - Specifies the human-readable name of the StoreFront.

Examples

Example 1 


C:\PS> $configuration = New-BrokerStorefrontAddress -Url "https://mysite.com/Citrix/StoreWeb" -Description "This StoreFront delivers my corporate applications" -Name "StoreFront1" -Enabled $true

C:\PS> Get-BrokerStorefrontAddress -ByteArray $configuration

Name               Url                                       Enabled Description

----               ---                                       ------- -----------

StoreFront1        https://mysite.com/Citrix/StoreWeb           True This StoreFront delivers my corporate applications.

<!--NeedCopy-->

Description

This example shows a new configuration byte array being created to specify a single StoreFront address. The configuration byte array is then provided as input to the Get-BrokerStorefrontAddress command, which interprets and outputs the same fields.

Get-BrokerStorefrontAddress
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.