Share via

AzurePostgreSqlLinkedService interface

Package:
@azure/arm-datafactory

Azure PostgreSQL linked service.

Extends
LinkedService

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

The credential reference containing authentication information.
database

Database name for connection. Type: string.
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.
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).
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).
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.
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.
type

Polymorphic discriminator, which specifies the different types this object can be
username

Username for authentication. Type: string.

Inherited Properties

annotations

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

The integration runtime reference.
description

Linked service description.
parameters

Parameters for linked service.
version

Version of the linked service.

Property Details

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

azureCloudType?: any

Property Value

any

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.

commandTimeout?: any

Property Value

any

connectionString

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

connectionString?: any

Property Value

any

credential

The credential reference containing authentication information.

credential?: CredentialReference

Property Value

CredentialReference

database

Database name for connection. Type: string.

database?: any

Property Value

any

encoding

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

encoding?: any

Property Value

any

encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptedCredential?: string

Property Value

string

password

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

password?: AzureKeyVaultSecretReference

Property Value

AzureKeyVaultSecretReference

port

The port for the connection. Type: integer.

port?: any

Property Value

any

readBufferSize

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

readBufferSize?: any

Property Value

any

server

Server name for connection. Type: string.

server?: any

Property Value

any

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

servicePrincipalCredentialType?: any

Property Value

any

servicePrincipalEmbeddedCert

Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).

servicePrincipalEmbeddedCert?: SecretBaseUnion

Property Value

SecretBaseUnion

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

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

Property Value

SecretBaseUnion

servicePrincipalId

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

servicePrincipalId?: any

Property Value

any

servicePrincipalKey

The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server.

servicePrincipalKey?: SecretBaseUnion

Property Value

SecretBaseUnion

sslMode

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

sslMode?: any

Property Value

any

tenant

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

tenant?: any

Property Value

any

timeout

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

timeout?: any

Property Value

any

timezone

Gets or sets the session timezone. Type: string.

timezone?: any

Property Value

any

trustServerCertificate

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

trustServerCertificate?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "AzurePostgreSql"

Property Value

"AzurePostgreSql"

username

Username for authentication. Type: string.

username?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version