Share via


AzurePostgreSqlLinkedService Class

Definition

Azure PostgreSQL linked service.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzurePostgreSqlLinkedService+AzurePostgreSqlLinkedServiceConverter))]
public class AzurePostgreSqlLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzurePostgreSqlLinkedService+AzurePostgreSqlLinkedServiceConverter))>]
type AzurePostgreSqlLinkedService = class
    inherit LinkedService
Public Class AzurePostgreSqlLinkedService
Inherits LinkedService
Inheritance
AzurePostgreSqlLinkedService
Attributes

Constructors

AzurePostgreSqlLinkedService()

Initializes a new instance of AzurePostgreSqlLinkedService.

Properties

AdditionalProperties

Additional Properties.

(Inherited from LinkedService)
Annotations

List of tags that can be used for describing the linked service.

(Inherited from LinkedService)
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).

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.

ConnectionString

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

ConnectVia

The integration runtime reference.

(Inherited from LinkedService)
Credential

The credential reference containing authentication information.

Database

Database name for connection. Type: string.

Description

Linked service description.

(Inherited from LinkedService)
Encoding

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

EncryptedCredential

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

Parameters

Parameters for linked service.

(Inherited from LinkedService)
Password

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

Port

The port for the connection. Type: integer.

ReadBufferSize

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

Server

Server name for connection. Type: string.

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).

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.

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.

ServicePrincipalId

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

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.

SslMode

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

Tenant

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

Timeout

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

Timezone

Gets or sets the session timezone. Type: string.

TrustServerCertificate

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

Username

Username for authentication. Type: string.

Version

Version of the linked service.

(Inherited from LinkedService)

Applies to