Configuring an ADF Linked Service Connection for Cassandra
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 underlying Azure Data Factory property names, with the connection column that carries each value named alongside. The exact labels shown in the BimlFlex Connection Editor may differ.
After selecting Cassandra from the Linked Service Type dropdown, the form required for creating a Cassandra Linked Service will appear.
The linked service is written at version 2.0.
Source Only Connector
A Cassandra connection is used as a source. It is not available as a target.
Each object is read through a dataset that takes the keyspace from the TargetSchemaName parameter and the table from the TargetObjectName parameter, and the query on the copy source reads the object.
Choosing an Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| Basic | Username and Password | None |
| Anonymous | None | None |
Recommendation: Store the Password in Azure Key Vault rather than entering it as plaintext.
Complete Example: Basic Authentication with Azure Key Vault
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Host | cassandra1.contoso.com |
| Port | 9042 |
| Authentication Type | Basic |
| Username | bfx_reader |
| Azure Key Vault Linked Service | bfx-kv |
| Secret Name (for Password) | BFX-SRC-CassandraPassword |
Required Fields
Common Required Fields
Some required fields for a Cassandra Linked Service connection depend on the Authentication Type used. There are some fields that are required regardless of Authentication Type.
These common required fields are:
Authentication Type Dependent Required Fields
Required fields for Basic:
- Username
- Password (or Azure Key Vault)
The Anonymous Authentication Type requires no further fields.
Optional fields are:
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for a Cassandra Linked Service connection.
The default value is AutoResolveIntegrationRuntime.
To use another runtime, select it from the dropdown or choose + New to add one.
When a custom value is saved in the linked service form, it will be added to the custom integration runtimes.
The custom values that appear in this dropdown can be maintained in Settings under Azure - AzureIntegrationRuntime.
The runtime is stored in the connection's LS_ConnectVia_IntegrationRuntime column. Any value other than AutoResolveIntegrationRuntime is written to the linked service as the runtime it connects through.
Host
The Host names one or more Cassandra servers by IP address or host name (for example, cassandra1.contoso.com).
A comma-separated list connects to all of the listed servers.
It is stored in the connection's LS_Host column and maps to the ADF host property.
Port
The Port is the TCP port the Cassandra server listens on for client connections.
It is stored in the connection's LS_Port column and maps to the ADF port property.
When it is not set, Azure Data Factory uses port 9042.
Authentication Type
The Cassandra Linked Service connection can use Basic or Anonymous authentication.
The selected value is stored in the connection's LS_AuthenticationType column and maps to the ADF authenticationType property.
When using Basic, a Username and Password are required.
Basic
Basic authentication signs in to Cassandra with a Username and Password.
The Username is stored in the connection's LS_Username column and maps to the ADF username property.
The Password field accepts the password as plaintext in the LS_Password column, or an Azure Key Vault reference held in the LS_PasswordKVS_ fields that resolves to the password at runtime. It maps to the ADF password property.
It is suggested that Azure Key Vault be used in place of manually entering the Password.
Anonymous
Anonymous authentication connects without a Username or Password.
Azure Data Factory Linked Service Additional Information
For additional information on ADF Cassandra Linked Service and its connection requirements see the Azure Data Factory Cassandra Connector documentation.