Azure DevOps Board Target Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Azure DevOps Board connector.

This topic describes how to authenticate to Azure DevOps Board and configure any necessary connection properties in the Azure DevOps Board connection connector.

Connection Configuration

Each connection property available in the Azure DevOps Board connector is explained below.

Connection Name

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Auth Scheme

The type of authentication to use when connecting to Azure DevOps Board.

Possible Values

AzureAD

If AzureAD is selected, an Azure Active Directory OAuth authentication will be performed.

Basic

If Basic is selected, additional configuration parameters will get listed.

Personal Access Token

The personal access token used for accessing the data in your organization.

The personal access token can be found in your Organization -> Profile -> Personal Access Tokens.

OAuth

If OAuth is selected, additional configuration parameters will get listed.

Client ID

The client ID assigned when you register your application with an OAuth authorization server.

Client Secret

The client secret assigned when you register your application with an OAuth authorization server.

Refresh Token

The OAuth refresh token for the corresponding OAuth access token.

Organization

The name of the Organization or Collection depending upon AzureDevOpsEdition value.

The request will return the data mapped under this Organization or Collection depending upon AzureDevOpsEdition value.

Azure DevOps Edition

The edition of AzureDevOps being used. Set either [AzureDevOps Online] or [AzureDevOps OnPremise].

[AzureDevOps OnPremise] supports only Basic as AuthScheme . Properties URL and User are mandatory and needs to be filled only in Case of [AzureDevOps OnPremise]. [AzureDevOps Online] supports all available AuthScheme .

Possible Values:

Azure DevOps Online

If Azure DevOps Online is selected, additional configuration parameters will get listed.

Azure DevOps OnPremises

If Azure DevOps OnPrem is selected, additional configuration parameters will get listed.

User

The Azure DevOps user account used to authenticate.

Enter only in case of AzureDevOpsEdition set to [AzureDevOps OnPremise].

URL

The Public URL of the AzureDevOps OnPremise Instance.

Example: http://localhost/defaultcollection

Enter only in case of AzureDevOpsEdition set to [AzureDevOps OnPremise].

Schema

Specify this property to connect with REST or Analytics services.

Set this property to REST to access AzureDevops REST endpoints or set to Analytics to access Odata Analytics service.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[ TableB/WithSlash ],WithCatalog.WithSchema. TableC With Space.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks.

Example: Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.ViewC With Space.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Browsable Schemas

This property restricts the schemas reported to a subset of the available schemas.

Example: BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.

If you have any feedback on Gathr documentation, please email us!

← Azure DevOps Board Incremental Configuration
Azure DevOps Board Ingestion Target →