Tips on utilizing a connected service in a custom Azure DevOps extension's index.ts file

Question

Tips on utilizing a connected service in a custom Azure DevOps extension's index.ts file

I have created a unique extension for Azure DevOps that includes a specialized Connected Service and Build task. When setting up the task through the pipeline visual designer, I am able to utilize the Connected Service to choose a service and then populate a picklist with data from my API.

My question is, how can I access the selected service when the task is running? In the index.ts file, I can obtain the Guid of the service using code similar to the snippet below. But, is there a way to use this Guid to retrieve the service or its details?


import tl = require('azure-pipelines-task-lib/task');
async function run() {
try {
    const serviceString: string = tl.getInput('TestService', true);
    if (serviceString == 'bad') {
        tl.setResult(tl.TaskResult.Failed, 'Bad input was given');
         return;
    } ...

I have searched extensively and reviewed various articles but have not come across any examples that address this specific scenario.

https://learn.microsoft.com/en-us/azure/devops/extend/develop/add-build-task?view=azure-devops

https://learn.microsoft.com/en-us/azure/devops/extend/develop/service-endpoints?view=azure-devops

typescript azure tfs azure-devops azure-pipelines

Answer 1

Answer №1

Utilizing additional functions from the azure-pipelines-task-lib/task library, specifically the tl object, is key to solving this issue:

If your custom Connected Service incorporates an authentication scheme categorized as

ms.vss-endpoint.endpoint-auth-scheme-token

, then the token input's identifier would be apitoken. In order to retrieve and use this token, you would need to implement code similar to the following:

const endpoint = tl.getEndpointUrl(serviceString, true);
// The second parameter in this context pertains to the input name associated with the specific type of authenticationScheme being utilized.
const token = tl.getEndpointAuthorizationParameter(serviceString, "apitoken", false)

My knowledge on this topic was gained through hands-on experimentation.

Diverse Authentication Methods

In my personal experience, aligning with the sentiments expressed by others' perspectives: Azure DevOps does not readily accommodate fully bespoke Connected Services. Instead, it provides a selection that covers various requirements. Depending on the chosen method(s), the value passed for the second parameter of

tl.getEndpointAuthorizationParameter

varies:

ms.vss-endpoint.endpoint-auth-scheme-token

This scheme includes a standard input:

apitoken

ms.vss-endpoint.endpoint-auth-scheme-basic

This scheme boasts two inputs:

username
password

Illustrative Instance with a Recommendation

Firstly, consider renaming your serviceString variable to connectedServiceId (or any variation that clarifies its purpose as representing the connected service's ID) to enhance code readability.

import tl = require('azure-pipelines-task-lib/task');

async function run() {
    try {
        const connectedServiceId = tl.getInput('TestService', true);

        if (connectedServiceId == 'bad' || connectedServiceId == undefined) {
            tl.setResult(tl.TaskResult.Failed, 'Bad input provided');
            return;
        }

        const endpoint = tl.getEndpointUrl(connectedServiceId, true);
        const token = tl.getEndpointAuthorizationParameter(connectedServiceId, "apitoken", false)
    }
    finally {
        // Handling potential failures here
    }
}

Furthermore, incorporating the connectedServiceId == undefined check ensures secure usage of the variable in subsequent function calls.

Useful Examples I Referenced/Created

Answer 2

Utilizing additional functions from the azure-pipelines-task-lib/task library, specifically the tl object, is key to solving this issue:

If your custom Connected Service incorporates an authentication scheme categorized as

ms.vss-endpoint.endpoint-auth-scheme-token

, then the token input's identifier would be apitoken. In order to retrieve and use this token, you would need to implement code similar to the following:

const endpoint = tl.getEndpointUrl(serviceString, true);
// The second parameter in this context pertains to the input name associated with the specific type of authenticationScheme being utilized.
const token = tl.getEndpointAuthorizationParameter(serviceString, "apitoken", false)

My knowledge on this topic was gained through hands-on experimentation.

Diverse Authentication Methods

In my personal experience, aligning with the sentiments expressed by others' perspectives: Azure DevOps does not readily accommodate fully bespoke Connected Services. Instead, it provides a selection that covers various requirements. Depending on the chosen method(s), the value passed for the second parameter of

tl.getEndpointAuthorizationParameter

varies:

ms.vss-endpoint.endpoint-auth-scheme-token

This scheme includes a standard input:

apitoken

ms.vss-endpoint.endpoint-auth-scheme-basic

This scheme boasts two inputs:

username
password

Illustrative Instance with a Recommendation

Firstly, consider renaming your serviceString variable to connectedServiceId (or any variation that clarifies its purpose as representing the connected service's ID) to enhance code readability.

import tl = require('azure-pipelines-task-lib/task');

async function run() {
    try {
        const connectedServiceId = tl.getInput('TestService', true);

        if (connectedServiceId == 'bad' || connectedServiceId == undefined) {
            tl.setResult(tl.TaskResult.Failed, 'Bad input provided');
            return;
        }

        const endpoint = tl.getEndpointUrl(connectedServiceId, true);
        const token = tl.getEndpointAuthorizationParameter(connectedServiceId, "apitoken", false)
    }
    finally {
        // Handling potential failures here
    }
}

Furthermore, incorporating the connectedServiceId == undefined check ensures secure usage of the variable in subsequent function calls.

Tips on utilizing a connected service in a custom Azure DevOps extension's index.ts file

Answer №1

Diverse Authentication Methods

ms.vss-endpoint.endpoint-auth-scheme-token

ms.vss-endpoint.endpoint-auth-scheme-basic

Illustrative Instance with a Recommendation

Useful Examples I Referenced/Created

Similar questions

Tips for preventing the occurrence of a final empty line in Deno's TextLineStream

Exploring the Differences Between Native Script and Ionic: A Guide to Choosing the Right Framework for Your Hybrid Apps

Guide to creating a Map with typescript

How to Eliminate Lower Borders from DataGrid Component in Material UI (mui)

Is it true that "Conditional types" are not compatible with actual functions?

Animation on React child component disappears when re-rendered

When using the `create-react-app` command with the `--typescript` flag, you may encounter an issue when attempting to compile namespaces with the `--

Using optional chaining on the left side in JavaScript is a convenient feature

I'm having trouble importing sqlite3 and knex-js into my Electron React application

How to exclude specific {} from TypeScript union without affecting other types

What could be causing this TypeScript class to not perform as anticipated?

Resolving Problems with Ion-Split-pane in the Latest Versions of Angular and Ionic

The issue of NestJS dependency injection not working within the MongooseModule.forFeatureAsync function call has been encountered

Issue with debugging Azure Functions TypeScript using f5 functionality is unresolved

Ensuring the inclusion of library licenses in the production build is a crucial step

Utilizing handpicked information in Angular: A beginner's guide

Leverage the power of function overloading in TypeScript for efficient code

When attempting to run a Typescript Playwright test in Visual Studio Code's debug mode, it inexplicably fails to execute

Issue arising from passing an object through a component in a Next.js application during build time when the object is retrieved from a database

Exploring the capabilities of google-diff-match-patch within the Angular framework