Citrix Virtual Apps and Desktops SDK

Get-Brokerstorefrontaddress

August 3, 2023

Contributed by:

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.

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

Get-Brokerstorefrontaddress

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-Brokerstorefrontaddress

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.Byte[]

Return Values

Citrix.Storefront.Sdk.Brokerstorefrontaddress

Examples

Example 1

Description

In this article