Share via


Set-SBCertificateAutogenerationKey

Set-SBCertificateAutogenerationKey

You can use this cmdlet to change a key used for encrypting auto-generated certificates. Note that this cmdlet regenerates the certificate authority and certificates.

Syntax

Parameter Set: AutoGeneratedCert
Set-SBCertificateAutogenerationKey -Key <SecureString> [-IgnoreEncryptionError] [-LastCertificateThumbprint <String> ] [-SBFarmDBConnectionString <String> ] [ <CommonParameters>]

Detailed Description

Run Set-SBCertificateAutogenerationKey to replace the certificate which was automatically generated when creating the Service Bus for Windows Server farm.

Use this cmdlet to follow security compliance requirement of changing certificate. You can also use it if you have forgotten the key used to create the auto generated certificate.

If you have previously copied the certificate authority to your client machines and since this cmdlet re-generated it, you must retrieve it using the Get-SBAutoGeneratedCA cmdlet and copy it to your client machines again.

Parameters

-IgnoreEncryptionError

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Key<SecureString>

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LastCertificateThumbprint<String>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SBFarmDBConnectionString<String>

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

Replace the current farm certificate with a new certificate.

PS C:\> $mycert=ConvertTo-SecureString -string myPassword1 -force -AsPlainText
Set-SBCertificateAutogenerationKey –Key $mycert

Service Bus 1.0 MSDN Community Forum