SALES: 1-800-867-1380
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
1 out of 1 rated this helpful - Rate this topic

Get-SBClientConfiguration

Updated: August 10, 2012

Get-SBClientConfiguration

This cmdlet retrieves the values of the Service Bus for Windows Server configuration settings that a Service Bus client requires.

Syntax

Parameter Set: Default
Get-SBClientConfiguration [-Namespaces <String[]> ] [ <CommonParameters>]




Detailed Description

Run Get-SBClientConfiguration to retrieve an XML data for use by Service Bus for Windows Server client applications. The Service Bus for Windows Server client configuration file includes the connection strings that the Service Bus for Windows Server API use to communicate with the Service Bus for Windows Server farm. You can provide one or more Service Bus for Windows Server service namespaces in order to scope the cmdlet output to a single service namespace or default to retrieve connection strings to all service namespaces the current user has access to.

Parameters

-Namespaces<String[]>

A comma-separated list of Service Bus for Windows Server service namespaces to be included in the generated configuration file. If the list is not provided, the created configuration file includes all service namespaces that the current user owns.


Aliases

ns

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1

Retrieves the Service Bus for Windows Server client configuration for all the Service Bus for Windows Server service namespaces.

The following example returns

Endpoint=sb://node1Fqdn/SBNameSpace01;StsEndpoint=https://node1Fqdn:9355/SBNameSpace01;RuntimePort=9354;ManagementPort=9355

Endpoint=sb://node2Fqdn/SBNameSpace02;StsEndpoint=https://node2Fqdn:9355/SBNameSpace02;RuntimePort=9354;ManagementPort=9355


PS C:\> Get-SBClientConfiguration

Example 2

Retrieves the Service Bus for Windows Server client configuration for all the Service Bus for Windows Server service namespaces with the name SBNameSpace01.

The following example returns

Endpoint=sb://node1Fqdn/SBNameSpace01;StsEndpoint=https://node1Fqdn:9355/SBNameSpace01;RuntimePort=9354;ManagementPort=9355


PS C:\> Get-SBClientConfiguration -Namespaces 'SBNameSpace01'

Example 3

Retrieves the Service Bus for Windows Server client configuration for all the service namespaces with the names MyNamespace1 and MyNamespace2.


PS C:\> Get-SBClientConfiguration -Namespaces MyNamespace1, MyNamespace2

Service Bus 1.0 MSDN Community Forum
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.