StartNewKeyPairRequest Method (_EasyUACertificateManagementClient)

Starts a request for a new certificate and private key. The certificate and private key are returned in the FinishRequest response.

Syntax

[NotNull()]
UANodeId StartNewKeyPairRequest( 
   object gdsEndpointDescriptor,
   object applicationId,
   object certificateGroupId,
   object certificateTypeId,
   string subjectName,
   object domainNames,
   string privateKeyFormat,
   string privateKeyPassword
)

[NotNull()]
UANodeId^ StartNewKeyPairRequest( 
   Object^ gdsEndpointDescriptor,
   Object^ applicationId,
   Object^ certificateGroupId,
   Object^ certificateTypeId,
   String^ subjectName,
   Object^ domainNames,
   String^ privateKeyFormat,
   String^ privateKeyPassword
)

'Declaration
 
<NotNullAttribute()>
Function StartNewKeyPairRequest( _
   ByVal gdsEndpointDescriptor As Object, _
   ByVal applicationId As Object, _
   ByVal certificateGroupId As Object, _
   ByVal certificateTypeId As Object, _
   ByVal subjectName As String, _
   ByVal domainNames As Object, _
   ByVal privateKeyFormat As String, _
   ByVal privateKeyPassword As String _
) As UANodeId

'Usage
 
Dim instance As _EasyUACertificateManagementClient
Dim gdsEndpointDescriptor As Object
Dim applicationId As Object
Dim certificateGroupId As Object
Dim certificateTypeId As Object
Dim subjectName As String
Dim domainNames As Object
Dim privateKeyFormat As String
Dim privateKeyPassword As String
Dim value As UANodeId
 
value = instance.StartNewKeyPairRequest(gdsEndpointDescriptor, applicationId, certificateGroupId, certificateTypeId, subjectName, domainNames, privateKeyFormat, privateKeyPassword)

Parameters

gdsEndpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server. The server must be a Global Directory Server (GDS).
applicationId: The identifier assigned to the Application Instance by the CertificateManager.
certificateGroupId: The NodeId of the Certificate Group which provides the context for the new request.
If OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.Null the CertificateManager shall choose the DefaultApplicationGroup.
certificateTypeId: The NodeId of the CertificateType for the new Certificate.
If OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.Null the CertificateManager shall generate a Certificate based on the value of the certificateGroupId argument.
subjectName: The subject name to use for the Certificate.
If not specified the ApplicationName and/or domainNames are used to create a suitable default value.
The format of the subject name is a sequence of name value pairs separated by a ‘/’. The name shall be one of ‘CN’, ‘O’, ‘OU’, ‘DC’, ‘L’, ‘S’ or ‘C’ and shall be followed by a ‘=’ and then followed by the value. The value may be any printable character except for ‘”’. If the value contains a ‘/’ or a ‘=’ then it shall be enclosed in double quotes (‘”’).
domainNames: The domain names to include in the Certificate.
If not specified the DiscoveryUrls are used to create suitable defaults.
privateKeyFormat: The format of the private key.
The following values are always supported:
PFX - PKCS #12 encoded
PEM - Base64 encoded DER(see RFC 5958).
privateKeyPassword: The password to use for the private key.

Return Value

Returns the Node ID that represents the request.
This value is passed to FinishRequest.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

If you want to obtain new certificate for the current client application, it is recommended that you use the higher-level OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.BeginObtainNewCertificate method instead.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

_EasyUACertificateManagementClient Interface
_EasyUACertificateManagementClient Members

Send Documentation Feedback. Technical Support