Class AzurePostgreSqlLinkedService

Azure PostgreSQL linked service.

Inheritance
System.Object
LinkedService
AzurePostgreSqlLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzurePostgreSqlLinkedService/AzurePostgreSqlLinkedServiceConverter))]
public class AzurePostgreSqlLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

AzurePostgreSqlLinkedService()

Initializes a new instance of AzurePostgreSqlLinkedService.

Declaration
public AzurePostgreSqlLinkedService ();

Properties

AzureCloudType

Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).

Declaration
public object AzureCloudType { get; set; }
Property Value
System.Object

CommandTimeout

The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer.

Declaration
public object CommandTimeout { get; set; }
Property Value
System.Object

ConnectionString

An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Declaration
public object ConnectionString { get; set; }
Property Value
System.Object

Credential

The credential reference containing authentication information.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.CredentialReference Credential { get; set; }
Property Value
CredentialReference

Database

Database name for connection. Type: string.

Declaration
public object Database { get; set; }
Property Value
System.Object

Encoding

Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string.

Declaration
public object Encoding { get; set; }
Property Value
System.Object

EncryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

Password

The Azure key vault secret reference of password in connection string.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.AzureKeyVaultSecretReference Password { get; set; }
Property Value
AzureKeyVaultSecretReference

Port

The port for the connection. Type: integer.

Declaration
public object Port { get; set; }
Property Value
System.Object

ReadBufferSize

Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer.

Declaration
public object ReadBufferSize { get; set; }
Property Value
System.Object

Server

Server name for connection. Type: string.

Declaration
public object Server { get; set; }
Property Value
System.Object

ServicePrincipalCredentialType

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).

Declaration
public object ServicePrincipalCredentialType { get; set; }
Property Value
System.Object

ServicePrincipalEmbeddedCert

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalEmbeddedCert { get; set; }
Property Value
SecretBase

ServicePrincipalEmbeddedCertPassword

Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalEmbeddedCertPassword { get; set; }
Property Value
SecretBase

ServicePrincipalId

The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string).

Declaration
public object ServicePrincipalId { get; set; }
Property Value
System.Object

ServicePrincipalKey

The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase ServicePrincipalKey { get; set; }
Property Value
SecretBase

SslMode

SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer.

Declaration
public object SslMode { get; set; }
Property Value
System.Object

Tenant

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Declaration
public object Tenant { get; set; }
Property Value
System.Object

Timeout

The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer.

Declaration
public object Timeout { get; set; }
Property Value
System.Object

Timezone

Gets or sets the session timezone. Type: string.

Declaration
public object Timezone { get; set; }
Property Value
System.Object

TrustServerCertificate

Whether to trust the server certificate without validating it. Type: boolean.

Declaration
public object TrustServerCertificate { get; set; }
Property Value
System.Object

Username

Username for authentication. Type: string.

Declaration
public object Username { get; set; }
Property Value
System.Object