CollaborationPlatform.BeginChangeCertificate Method (String, Byte , AsyncCallback, Object)
Dynamically changes the certificate to be used.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginChangeCertificate ( _
certificateIssuerName As String, _
certificateSerialNumber As Byte(), _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As CollaborationPlatform
Dim certificateIssuerName As String
Dim certificateSerialNumber As Byte()
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginChangeCertificate(certificateIssuerName, _
certificateSerialNumber, userCallback, _
state)
public IAsyncResult BeginChangeCertificate(
string certificateIssuerName,
byte[] certificateSerialNumber,
AsyncCallback userCallback,
Object state
)
Parameters
- certificateIssuerName
Type: System.String
The issuer name for the new certificate.
- certificateSerialNumber
Type: []
The serial number for the new certificate.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown when the platform has not been configured with MTLS. |
| InvalidOperationException | Thrown when the platform is not in the correct state to change the certificate. |
| ArgumentNullException | Thrown when one of more arguments are null. |
| ArgumentException | Thrown when one or more of the arguments are invalid. |
| TlsFailureException | Thrown when the certificate is invalid or unusable. |
Remarks
For auto-provisioned platforms this method need not be used since certificate changes are automatically applied.
In order to change the certficate, the platform needs to stop listening, change the certificate, and start listening again. While this does not affect existing connections, there could be a temporary problem in accepting new incoming connections.