PostgreSqlV2LinkedService Class
Linked service for PostgreSQLV2 data source.
All required parameters must be populated in order to send to server.
Constructor
PostgreSqlV2LinkedService(*, server: MutableMapping[str, Any], username: MutableMapping[str, Any], database: MutableMapping[str, Any], authentication_type: MutableMapping[str, Any], ssl_mode: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, port: MutableMapping[str, Any] | None = None, schema: MutableMapping[str, Any] | None = None, pooling: MutableMapping[str, Any] | None = None, connection_timeout: MutableMapping[str, Any] | None = None, command_timeout: MutableMapping[str, Any] | None = None, trust_server_certificate: MutableMapping[str, Any] | None = None, ssl_certificate: MutableMapping[str, Any] | None = None, ssl_key: MutableMapping[str, Any] | None = None, ssl_password: MutableMapping[str, Any] | None = None, read_buffer_size: MutableMapping[str, Any] | None = None, log_parameters: MutableMapping[str, Any] | None = None, timezone: MutableMapping[str, Any] | None = None, encoding: MutableMapping[str, Any] | None = None, password: _models.AzureKeyVaultSecretReference | None = None, encrypted_credential: str | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
version
|
Version of the linked service. Default value: None
|
|
connect_via
|
The integration runtime reference. Default value: None
|
|
description
|
Linked service description. Default value: None
|
|
parameters
|
Parameters for linked service. Default value: None
|
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. Default value: None
|
|
server
|
<xref:JSON>
Server name for connection. Type: string. Required. |
|
port
|
<xref:JSON>
The port for the connection. Type: integer. Default value: None
|
|
username
|
<xref:JSON>
Username for authentication. Type: string. Required. |
|
database
|
<xref:JSON>
Database name for connection. Type: string. Required. |
|
authentication_type
|
<xref:JSON>
The authentication type to use. Type: string. Required. |
|
ssl_mode
|
<xref:JSON>
SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. Required. |
|
schema
|
<xref:JSON>
Sets the schema search path. Type: string. Default value: None
|
|
pooling
|
<xref:JSON>
Whether connection pooling should be used. Type: boolean. Default value: None
|
|
connection_timeout
|
<xref:JSON>
The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. Default value: None
|
|
command_timeout
|
<xref:JSON>
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. Default value: None
|
|
trust_server_certificate
|
<xref:JSON>
Whether to trust the server certificate without validating it. Type: boolean. Default value: None
|
|
ssl_certificate
|
<xref:JSON>
Location of a client certificate to be sent to the server. Type: string. Default value: None
|
|
ssl_key
|
<xref:JSON>
Location of a client key for a client certificate to be sent to the server. Type: string. Default value: None
|
|
ssl_password
|
<xref:JSON>
Password for a key for a client certificate. Type: string. Default value: None
|
|
read_buffer_size
|
<xref:JSON>
Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. Default value: None
|
|
log_parameters
|
<xref:JSON>
When enabled, parameter values are logged when commands are executed. Type: boolean. Default value: None
|
|
timezone
|
<xref:JSON>
Gets or sets the session timezone. Type: string. Default value: None
|
|
encoding
|
<xref:JSON>
Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string. Default value: None
|
|
password
|
The Azure key vault secret reference of password in connection string. Type: string. Default value: None
|
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of linked service. Required. |
|
version
|
Version of the linked service. |
|
connect_via
|
The integration runtime reference. |
|
description
|
Linked service description. |
|
parameters
|
Parameters for linked service. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the linked service. |
|
server
|
<xref:JSON>
Server name for connection. Type: string. Required. |
|
port
|
<xref:JSON>
The port for the connection. Type: integer. |
|
username
|
<xref:JSON>
Username for authentication. Type: string. Required. |
|
database
|
<xref:JSON>
Database name for connection. Type: string. Required. |
|
authentication_type
|
<xref:JSON>
The authentication type to use. Type: string. Required. |
|
ssl_mode
|
<xref:JSON>
SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. Required. |
|
schema
|
<xref:JSON>
Sets the schema search path. Type: string. |
|
pooling
|
<xref:JSON>
Whether connection pooling should be used. Type: boolean. |
|
connection_timeout
|
<xref:JSON>
The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. |
|
command_timeout
|
<xref:JSON>
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. |
|
trust_server_certificate
|
<xref:JSON>
Whether to trust the server certificate without validating it. Type: boolean. |
|
ssl_certificate
|
<xref:JSON>
Location of a client certificate to be sent to the server. Type: string. |
|
ssl_key
|
<xref:JSON>
Location of a client key for a client certificate to be sent to the server. Type: string. |
|
ssl_password
|
<xref:JSON>
Password for a key for a client certificate. Type: string. |
|
read_buffer_size
|
<xref:JSON>
Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. |
|
log_parameters
|
<xref:JSON>
When enabled, parameter values are logged when commands are executed. Type: boolean. |
|
timezone
|
<xref:JSON>
Gets or sets the session timezone. Type: string. |
|
encoding
|
<xref:JSON>
Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string. |
|
password
|
The Azure key vault secret reference of password in connection string. Type: string. |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
