AzurePostgreSqlLinkedService Class
Azure PostgreSQL linked service.
All required parameters must be populated in order to send to server.
Constructor
AzurePostgreSqlLinkedService(*, 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, connection_string: MutableMapping[str, Any] | None = None, server: MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None = None, database: MutableMapping[str, Any] | None = None, ssl_mode: MutableMapping[str, Any] | None = None, timeout: MutableMapping[str, Any] | None = None, command_timeout: MutableMapping[str, Any] | None = None, trust_server_certificate: MutableMapping[str, Any] | None = None, read_buffer_size: 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, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase | None = None, service_principal_credential_type: MutableMapping[str, Any] | None = None, service_principal_embedded_cert: _models.SecretBase | None = None, service_principal_embedded_cert_password: _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None, azure_cloud_type: MutableMapping[str, Any] | None = None, credential: _models.CredentialReference | 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
|
|
connection_string
|
<xref:JSON>
An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Default value: None
|
|
server
|
<xref:JSON>
Server name for connection. Type: string. Default value: None
|
|
port
|
<xref:JSON>
The port for the connection. Type: integer. Default value: None
|
|
username
|
<xref:JSON>
Username for authentication. Type: string. Default value: None
|
|
database
|
<xref:JSON>
Database name for connection. Type: string. Default value: None
|
|
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. Default value: None
|
|
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
|
|
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
|
|
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. 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
|
|
service_principal_id
|
<xref:JSON>
The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string). Default value: None
|
|
service_principal_key
|
The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Default value: None
|
|
service_principal_credential_type
|
<xref:JSON>
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). Default value: None
|
|
service_principal_embedded_cert
|
Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). Default value: None
|
|
service_principal_embedded_cert_password
|
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). Default value: None
|
|
tenant
|
<xref:JSON>
The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). Default value: None
|
|
azure_cloud_type
|
<xref:JSON>
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). Default value: None
|
|
credential
|
The credential reference containing authentication information. 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. |
|
connection_string
|
<xref:JSON>
An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. |
|
server
|
<xref:JSON>
Server name for connection. Type: string. |
|
port
|
<xref:JSON>
The port for the connection. Type: integer. |
|
username
|
<xref:JSON>
Username for authentication. Type: string. |
|
database
|
<xref:JSON>
Database name for connection. Type: string. |
|
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. |
|
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. |
|
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. |
|
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. |
|
encrypted_credential
|
The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. |
|
service_principal_id
|
<xref:JSON>
The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string). |
|
service_principal_key
|
The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. |
|
service_principal_credential_type
|
<xref:JSON>
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). |
|
service_principal_embedded_cert
|
Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). |
|
service_principal_embedded_cert_password
|
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). |
|
tenant
|
<xref:JSON>
The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). |
|
azure_cloud_type
|
<xref:JSON>
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). |
|
credential
|
The credential reference containing authentication information. |
