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

NPM Package: Accessing resources from within the package

Encountering 404 errors when reloading routes on an Angular Azure static web app

The concept of Nested TypeScript Map Value Type

What could be causing the issue of CSS Styles not being applied to an Angular 2 component with Vaadin elements?

Developing a discriminated union by utilizing the attribute names from a different type

Encountering problems with createMediaElementSource in TypeScript/React when using the Web Audio API

The SDK directory for TypeScript 1.3 in Visual Studio 2013 does not include the necessary tsc.exe file

What sets apart the Partial and Optional operators in Typescript?

Adding a new property to the Express request object type: what you need to know

What is the best way to retrieve a value from an array of objects containing both objects and strings in TypeScript?

Embedding images using a blob or base64 format does not function properly on iOS devices

Obtaining distinct form control values for replicated form fields with Angular

Include a search query parameter in the URL by adding "?search=" to connect with a

Searching for two variables in an API using TypeScript pipes

filter failing to provide output

Mastering the Art of Concise Writing: Tips to

Issue with my TypeScript modules TS2307: Module not found

Can a map key value be converted into a param object?

What is the best way to retrieve an object within a class?

Having trouble getting navigation to work using react-navigation and typescript in a react-native project?