Configuring an ADF Linked Service Connection for Amazon RDS for Oracle
For information on how to enable a connection for use with linked services, see Configuring a Linked Service Connection.
Field labels in this walkthrough follow the BimlFlex Connection Editor, with the connection column that carries each value and the Azure Data Factory property it maps to named alongside.
After selecting Amazon RDS for Oracle from the Linked Service Type dropdown, the form required for creating an Amazon RDS for Oracle Linked Service will appear.
Source Only Connector
An Amazon RDS for Oracle connection is used as a source. It is not available as a target.
The connector is built for Azure Data Factory projects.
The Amazon RDS for Oracle Linked Service Type is offered on connections that use the Amazon RDS for Oracle System Type.
Objects on an Amazon RDS for Oracle connection are typed as Table or View. Each object is read through a dataset parameterized on schema and table, and the query on the copy source reads the object.
Choosing an Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| Basic | User Name and Password | None |
Recommendation: Store the Password in Azure Key Vault rather than entering it as plaintext.
Complete Example: Basic Authentication with Azure Key Vault
The values below are made up for illustration.
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Server | contoso-sales.rds.amazonaws.com:1521/SALES |
| Authentication Type | Basic |
| User Name | bfx_reader |
| AKV Linked Service (Password, Azure Key Vault Password tab) | bfx-kv |
| Secret Name (Password, Azure Key Vault Password tab) | BFX-SRC-SalesOraclePassword |
Required Fields
Common Required Fields
An Amazon RDS for Oracle Linked Service connection uses a single Authentication Type, so the same fields are required on every connection.
These common required fields are:
Optional fields are:
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for an Amazon RDS for Oracle Linked Service connection.
The default value is AutoResolveIntegrationRuntime.
To use another runtime, select it from the dropdown or choose + New to add one.
The custom values that appear in this dropdown can be maintained in Settings under Azure, in the AzureIntegrationRuntime setting.
The value is stored in the connection's LS_ConnectVia_IntegrationRuntime column and maps to the ADF connectVia property.
When the value is AutoResolveIntegrationRuntime, no connectVia property is written and the default Azure integration runtime is used.
When the Amazon RDS for Oracle database is located inside an Amazon Virtual Private Cloud, Azure Data Factory connects to it through a self-hosted integration runtime.
Server
The Server is required for an Amazon RDS for Oracle Linked Service connection and identifies the Amazon RDS for Oracle database the connector reads from (for example, contoso-sales.rds.amazonaws.com:1521/SALES).
It is stored in the connection's LS_Server column and maps to the ADF server property.
The formats the server property accepts are listed in the Microsoft connector documentation linked at the end of this page.
Authentication Type
The Amazon RDS for Oracle Linked Service connection signs in with Basic authentication.
The Authentication Type dropdown offers Basic, and the Connection Editor fills in Basic when a connection without an Authentication Type is opened.
The value is stored in the connection's LS_AuthenticationType column and maps to the ADF authenticationType property.
For Basic, a User Name and Password are required to sign in. The form does not enforce either field, so enter both before saving the connection.
Basic
Basic authentication signs in to the Amazon RDS for Oracle database with a User Name and Password.
The User Name is stored in the connection's LS_Username column and maps to the ADF username property.
The Password field has two tabs, Password and Azure Key Vault Password.
It accepts the password as plaintext in the LS_Password column, or an Azure Key Vault reference stored in the LS_PasswordKVS_ fields that resolves to the password at runtime.
Either form maps to the ADF password property.
It is suggested that Azure Key Vault be used in place of manually entering the Password.
Additional Connection Properties
The Additional connection properties table holds one row per property, with a Property name column and a Value column.
Select New to add a row. To remove rows, check them and select Delete.
When the connection has no additional connection properties, the table opens with these four rows:
| Property name | Value |
|---|---|
encryptionClient | requested |
encryptionTypesClient | (AES256) |
cryptoChecksumClient | requested |
cryptoChecksumTypesClient | (SHA256) |
The rows are saved to the connection's LS_AdditionalConnectionProperties column as a JSON object of property names and values. A row with no property name is not saved.
When every row is deleted, no additional connection properties are saved.
The table then shows the four rows as soon as the save completes, and each time the connection is opened.
Each property in the object is written to the linked service as an additional connection property.
The first letter of each property name is written in lower case, so FetchSize is written to the linked service as fetchSize.
The other Oracle connection settings, such as fetchSize, statementCacheSize and initializationString, are added as rows in the same way.
The Amazon RDS for Oracle linked service is written without a connection string, so the form has no Additional Connection String Properties field.
Azure Data Factory Linked Service Additional Information
For additional information on ADF Amazon RDS for Oracle Linked Service and its connection requirements see the Azure Data Factory Amazon RDS for Oracle Connector documentation.