StartNewKeyPairRequest Method (IEasyUACertificateManagement)

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

Syntax

Visual Basic
C#
C++/CLI

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

'Usage
 
Dim instance As IEasyUACertificateManagement
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim applicationId As UANodeId
Dim certificateGroupId As UANodeId
Dim certificateTypeId As UANodeId
Dim subjectName As String
Dim domainNames As IEnumerable(Of String)
Dim privateKeyFormat As String
Dim privateKeyPassword As String
Dim value As UANodeId
 
value = instance.StartNewKeyPairRequest(gdsEndpointDescriptor, applicationId, certificateGroupId, certificateTypeId, subjectName, domainNames, privateKeyFormat, privateKeyPassword)

[NotNull()]
UANodeId StartNewKeyPairRequest( 
   UAEndpointDescriptor gdsEndpointDescriptor,
   UANodeId applicationId,
   UANodeId certificateGroupId,
   UANodeId certificateTypeId,
   string subjectName,
   IEnumerable<string> domainNames,
   string privateKeyFormat,
   string privateKeyPassword
)

[NotNull()]
UANodeId^ StartNewKeyPairRequest( 
   UAEndpointDescriptor^ gdsEndpointDescriptor,
   UANodeId^ applicationId,
   UANodeId^ certificateGroupId,
   UANodeId^ certificateTypeId,
   String^ subjectName,
   IEnumerable<String^>^ domainNames,
   String^ privateKeyFormat,
   String^ privateKeyPassword
)

Parameters

gdsEndpointDescriptor

Endpoint descriptor. Identifies the OPC-UA server. The server must be a Global Directory Server (GDS).

Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromUri static method instead.

Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to OpcLabs.EasyOpc.UA.UAEndpointDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement (results from OPC UA discovery) in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a (non-null) OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement to OpcLabs.EasyOpc.UA.UAEndpointDescriptor using the ToUAEndpointDescriptor or ToUAEndpointDescriptor method instead.

If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.