Configuring an ADF Linked Service Connection for Jira
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 Jira from the Linked Service Type dropdown, the form required for creating a Jira Linked Service will appear.
Source Only Connector
A Jira connection is used as a source. It is not available as a target.
The Jira Linked Service Type is offered on connections that use the Jira System Type.
Each Jira object is read whole from the table that the dataset names through the TargetObjectName parameter, with the schema in the TargetSchemaName parameter. The copy source passes the two parameters, with the source object name in TargetObjectName, and carries no query. BimlFlex composes no query for the object.
A filled Override SQL on a Jira object is not written to the copy source, and neither is the text of the object's Override SQL extension point when the Override SQL is empty. The build reports a warning that names the object, and the copy reads the whole object.
The object's Where SQL, Group By SQL and Order By SQL and the Append Source SQL extension point do not apply to a Jira object.
When the object has additional columns, they are written to the copy source.
The Microsoft documentation linked at the end of this page lists the Jira tables that version 2.0 supports.
Choosing an Authentication Method
| Method | Credentials |
|---|---|
| Basic | User Name and the Atlassian API token or password |
The Jira linked service signs in with the User Name and the Password field, which holds the Atlassian API token or the password of the account. BimlFlex does not read the connection's Authentication Type column for this connector.
Recommendation: Store the API token or 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 |
| Host | contoso.atlassian.net |
| Port | 443 |
| User Name | [email protected] |
| AKV Linked Service (Password, Azure Key Vault tab) | bfx-kv |
| Secret Name (Password, Azure Key Vault tab) | BFX-JiraApiToken |
From these values the build writes a linked service with version set to 2.0, the host, port and username, and a password that references the secret in Azure Key Vault.
Required Fields
These fields are required for every Jira Linked Service connection:
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for a Jira 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.
A self-hosted integration runtime for the Jira connector at version 2.0 should be version 5.61 or above.
Host
The Host is the IP address or host name of the Jira service (for example, contoso.atlassian.net).
It is stored in the connection's LS_Host column and maps to the ADF host property.
Port
The Port is the TCP port that the Jira server listens on.
It is stored in the connection's LS_Port column and maps to the ADF port property.
When the Port is empty, no port property is written and the service default applies: 443 when connecting through HTTPS, or 8080 when connecting through HTTP.
User Name
The User Name is the user name that accesses the Jira service.
It is stored in the connection's LS_Username column and maps to the ADF username property.
Password
The Password field holds the Atlassian API token, when two-step verification is enabled on the Atlassian account, or the password of the user.
It accepts the value as plaintext in the LS_Password column on the Password tab, or an Azure Key Vault reference on the Azure Key Vault tab that resolves to the value at runtime.
The Azure Key Vault reference is stored in the LS_PasswordKVS_ fields: AKV Linked Service, Secret Name, and an optional Secret Version.
It is written when both the AKV Linked Service and the Secret Name are filled.
Either form maps to the ADF password property.
When the AKV Linked Service is filled, the plaintext password is not written to the linked service.
It is suggested that Azure Key Vault be used in place of manually entering the API token or password.
Encrypted Credential
When the connection's LS_EncryptedCredential column is filled, its value is written to the ADF encryptedCredential property.
The Jira form has no field for it, and a value stored in the column is kept when the connection is saved.
Azure Data Factory Linked Service Additional Information
For additional information on ADF Jira Linked Service and its connection requirements see the Azure Data Factory Jira Connector documentation.