Class CreateMicrosoftSqlserverConnectionDetails

The information about a new Microsoft SQL Server Connection.

Inheritance

object

CreateConnectionDetails

CreateMicrosoftSqlserverConnectionDetails

Inherited Members

CreateConnectionDetails.DisplayName

CreateConnectionDetails.Description

CreateConnectionDetails.CompartmentId

CreateConnectionDetails.FreeformTags

CreateConnectionDetails.DefinedTags

CreateConnectionDetails.Locks

CreateConnectionDetails.VaultId

CreateConnectionDetails.KeyId

CreateConnectionDetails.NsgIds

CreateConnectionDetails.SubnetId

CreateConnectionDetails.RoutingMethod

CreateConnectionDetails.DoesUseSecretIds

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GoldengateService.Models

Assembly: OCI.DotNetSDK.Goldengate.dll

Syntax

public class CreateMicrosoftSqlserverConnectionDetails : CreateConnectionDetails

Properties

AdditionalAttributes

Declaration

[JsonProperty(PropertyName = "additionalAttributes")]
public List<NameValuePair> AdditionalAttributes { get; set; }

Property Value

Type	Description
List<NameValuePair>	An array of name-value pair attribute entries. Used as additional parameters in connection string.

DatabaseName

Declaration

[Required(ErrorMessage = "DatabaseName is required.")]
[JsonProperty(PropertyName = "databaseName")]
public string DatabaseName { get; set; }

Property Value

Type	Description
string	The name of the database.

Remarks

Required

Host

Declaration

[Required(ErrorMessage = "Host is required.")]
[JsonProperty(PropertyName = "host")]
public string Host { get; set; }

Property Value

Type	Description
string	The name or address of a host.

Remarks

Required

Password

Declaration

[JsonProperty(PropertyName = "password")]
public string Password { get; set; }

Property Value

Type	Description
string	The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

PasswordSecretId

Declaration

[JsonProperty(PropertyName = "passwordSecretId")]
public string PasswordSecretId { get; set; }

Property Value

Type	Description
string	The OCID of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server. Note: When provided, 'password' field must not be provided.

Port

Declaration

[Required(ErrorMessage = "Port is required.")]
[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }

Property Value

Type	Description
int?	The port of an endpoint usually specified for a connection.

Remarks

Required

PrivateIp

Declaration

[JsonProperty(PropertyName = "privateIp")]
public string PrivateIp { get; set; }

Property Value

Type	Description
string	Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Type

Description

string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

SecurityProtocol

Declaration

[Required(ErrorMessage = "SecurityProtocol is required.")]
[JsonProperty(PropertyName = "securityProtocol")]
[JsonConverter(typeof(StringEnumConverter))]
public MicrosoftSqlserverConnection.SecurityProtocolEnum? SecurityProtocol { get; set; }

Property Value

Type	Description
MicrosoftSqlserverConnection.SecurityProtocolEnum?	Security Type for Microsoft SQL Server.

Remarks

Required

ShouldValidateServerCertificate

Declaration

[JsonProperty(PropertyName = "shouldValidateServerCertificate")]
public bool? ShouldValidateServerCertificate { get; set; }

Property Value

Type	Description
bool?	If set to true, the driver validates the certificate that is sent by the database server.

SslCa

Declaration

[JsonProperty(PropertyName = "sslCa")]
public string SslCa { get; set; }

Property Value

Type	Description
string	Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).

TechnologyType

Declaration

[Required(ErrorMessage = "TechnologyType is required.")]
[JsonProperty(PropertyName = "technologyType")]
[JsonConverter(typeof(StringEnumConverter))]
public MicrosoftSqlserverConnection.TechnologyTypeEnum? TechnologyType { get; set; }

Property Value

Type	Description
MicrosoftSqlserverConnection.TechnologyTypeEnum?	The Microsoft SQL Server technology type.

Remarks

Required

Username

Declaration

[Required(ErrorMessage = "Username is required.")]
[JsonProperty(PropertyName = "username")]
public string Username { get; set; }

Property Value

Type	Description
string	The username Oracle GoldenGate uses to connect to the Microsoft SQL Server. This username must already exist and be available by the Microsoft SQL Server to be connected to.

Remarks

Required