Get-SBMessageContainer
Get-SBMessageContainer
You can use this cmdlet to retrieve the details about Service Bus for Windows Server message containers.
Syntax
Parameter Set: Default
Get-SBMessageContainer [-Id <Int64> ] [-ShowEntities] [ <CommonParameters>]
Detailed Description
Run Get-SBMessageContainer to retrieve the details for the Service Bus for Windows Server message containers. A Service Bus for Windows Server message container holds a connection string to a messaging database where Service Bus for Windows Server stores messages. For scale out deployments where a single Service Bus for Windows Server farm is required to deal with many entities (queues or topics), it is highly recommended to create multiple Service Bus for Windows Server message containers.
If the -ID parameter is provided, only the information regarding that particular message container is returned. If no ID is specified this command will return the information for all message containers.
If the Entities parameter is specified, the entity information for each container is also returned.
Parameters
-Id<Int64>
The message container ID.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-ShowEntities
This parameter indicates that the entities for a message container are also to be returned.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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.
- Name, DatabaseName
Examples
Example 1
Returns all the message containers.
PS C:\> Get-SBMessageContainer
Example 2
Returns the message container with the ID of 1.
PS C:\> Get-SBMessageContainer -Id 1
Example 3
Returns the message container with the ID of 1 with all the names of the entities it holds.
PS C:\> Get-SBMessageContainer -Id 1 -ShowEntities
Cmdlet Syntax
PS C:\> Get-SBMessageContainer [-ID <long>] [<CommonParameters>]
Get-SBMessageContainer [<CommonParameters>]
Get-SBMessageContainer [-ID <long>] [-ShowEntities <SwitchParameter>] [<CommonParameters>]
Get-SBMessageContainer [-ShowEntities <SwitchParameter>] [<CommonParameters>]