Set-SBCertificate
Set-SBCertificate
You can use this cmdlet to change a custom certificate or move from an auto-generated certificate to a custom certificate. Read the documentation on the entire set of steps required to change the certificate.
Syntax
Parameter Set: FarmAndEncryptionCert
Set-SBCertificate [-EncryptionCertificateThumbprint <String> ] [-FarmCertificateThumbprint <String> ] [-IgnoreEncryptionError] [-SBFarmDBConnectionString <String> ] [-SkipKeyReEncryption] [ <CommonParameters>]
Detailed Description
Run Set-SBCertificate to replace the certificate provided to the Service Bus for Windows Server farm. Use this cmdlet to follow a security compliance requirement of changing certificates.
Parameters
-EncryptionCertificateThumbprint<String>
This certificate is used for securing the SQL connection strings. If not provided, it takes the value of the SslCertificate. Represents the encryption certificate.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FarmCertificateThumbprint<String>
A custom certificate that the Service Bus uses.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IgnoreEncryptionError
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SBFarmDBConnectionString<String>
Represents a connection string of the configuration database.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SkipKeyReEncryption
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.
Examples
Example
Change a custom certificate.
PS C:\> Set-SBCertificate -SBFarmDBConnectionString 'Data Source= SqlServerName;Initial Catalog=SbManagementDB;Integrated Security=True' -FarmCertThumbprint ‘CertificateThumbPrint’