Package version:

Interface AzurePostgreSqlLinkedService

Azure PostgreSQL linked service.

interface AzurePostgreSqlLinkedService {
    annotations?: any[];
    azureCloudType?: any;
    commandTimeout?: any;
    connectionString?: any;
    connectVia?: IntegrationRuntimeReference;
    credential?: CredentialReference;
    database?: any;
    description?: string;
    encoding?: any;
    encryptedCredential?: string;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    password?: AzureKeyVaultSecretReference;
    port?: any;
    readBufferSize?: any;
    server?: any;
    servicePrincipalCredentialType?: any;
    servicePrincipalEmbeddedCert?: SecretBaseUnion;
    servicePrincipalEmbeddedCertPassword?: SecretBaseUnion;
    servicePrincipalId?: any;
    servicePrincipalKey?: SecretBaseUnion;
    sslMode?: any;
    tenant?: any;
    timeout?: any;
    timezone?: any;
    trustServerCertificate?: any;
    type: "AzurePostgreSql";
    username?: any;
    version?: string;
}

Hierarchy (view full)

Properties

annotations? azureCloudType? commandTimeout? connectionString? connectVia? credential? database? description? encoding? encryptedCredential? parameters? password? port? readBufferSize? server? servicePrincipalCredentialType? servicePrincipalEmbeddedCert? servicePrincipalEmbeddedCertPassword? servicePrincipalId? servicePrincipalKey? sslMode? tenant? timeout? timezone? trustServerCertificate? type username? version?

Properties

Optionalannotations

annotations?: any[]

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

OptionalazureCloudType

azureCloudType?: any

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

OptionalcommandTimeout

commandTimeout?: any

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.

OptionalconnectionString

connectionString?: any

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

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

Optionalcredential

credential?: CredentialReference

The credential reference containing authentication information.

Optionaldatabase

database?: any

Database name for connection. Type: string.

Optionaldescription

description?: string

Linked service description.

Optionalencoding

encoding?: any

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

OptionalencryptedCredential

encryptedCredential?: string

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

Optionalparameters

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

Parameters for linked service.

Optionalpassword

password?: AzureKeyVaultSecretReference

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

Optionalport

port?: any

The port for the connection. Type: integer.

OptionalreadBufferSize

readBufferSize?: any

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

Optionalserver

server?: any

Server name for connection. Type: string.

OptionalservicePrincipalCredentialType

servicePrincipalCredentialType?: any

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

OptionalservicePrincipalEmbeddedCert

servicePrincipalEmbeddedCert?: SecretBaseUnion

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

OptionalservicePrincipalEmbeddedCertPassword

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

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

OptionalservicePrincipalId

servicePrincipalId?: any

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

OptionalservicePrincipalKey

servicePrincipalKey?: SecretBaseUnion

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

OptionalsslMode

sslMode?: any

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

Optionaltenant

tenant?: any

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

Optionaltimeout

timeout?: any

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

Optionaltimezone

timezone?: any

Gets or sets the session timezone. Type: string.

OptionaltrustServerCertificate

trustServerCertificate?: any

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

type

type

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

Optionalusername

username?: any

Username for authentication. Type: string.

Optionalversion

version?: string

Version of the linked service.

Settings

Member Visibility