Restore-SBMessageContainer
Restore-SBMessageContainer
You can use this cmdlet to restore Service Bus for Windows Server message container from a backup.
Syntax
Parameter Set: AutoCert
Restore-SBMessageContainer -ContainerDBConnectionString <String> [-CertificateAutoGenerationKey <SecureString> ] [-Force] [-Id <Int64> ] [-SBFarmDBConnectionString <String> ] [ <CommonParameters>]
Detailed Description
Run Restore-SBMessageContainer to restore a Service Bus for Windows Server message container from a backup. If an ID is provided, this cmdlet will restore the backup container to the specified ID. Restoring the Service Bus for Windows Server message container database includes all the Service Bus for Windows Server entities as well as the messages which were stored within these entities. However, if the time-to-live value of the messages has expired, they will be dropped from the imported message container.
Note: You may use this cmdlet for moving message containers between two different servers. This can be useful if you wish to take a snapshot of your production server and import it to a test environment for debugging.
Parameters
-CertificateAutoGenerationKey<SecureString>
This passphrase is required for certificate auto generation. This parameter is mandatory if you want certificates to be auto generated.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ContainerDBConnectionString<String>
Represents a connection string of the Service Bus for Windows Server container database.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Specifies the force value.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Id<Int64>
Specifies the ID of the Service Bus for Windows Server message container.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-SBFarmDBConnectionString<String>
Represents a connection string of the Service Bus for Windows Server database.
Aliases |
none |
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 (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.
Examples
Example 1
PS C:\> Restore-SBMessageContainer -Id 1 -ContainerDBConnectionString "data source=localhost\sqlexpress; integrated security=true"