Azure DevOps Provider: Installation & Configuration
Installation
The azuredevops provider is available as a package in all Pulumi languages:
- JavaScript/TypeScript:
@pulumi/azuredevops
- Python:
pulumi-azuredevops
- Go:
github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops
- .NET:
Pulumi.Azuredevops
- Java:
com.pulumi/azuredevops
The Azure DevOps provider can be used to configure Azure DevOps project in Microsoft Azure using Azure DevOps Service REST API
Use the navigation to the left to read about the available resources.
Interested in the provider’s latest features, or want to make sure you’re up to date? Check out the changelog for version information and release notes.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const project = new azuredevops.Project("project", {
name: "Project Name",
description: "Project Description",
});
import pulumi
import pulumi_azuredevops as azuredevops
project = azuredevops.Project("project",
name="Project Name",
description="Project Description")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() =>
{
var project = new AzureDevOps.Project("project", new()
{
Name = "Project Name",
Description = "Project Description",
});
});
package main
import (
"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := azuredevops.NewProject(ctx, "project", &azuredevops.ProjectArgs{
Name: pulumi.String("Project Name"),
Description: pulumi.String("Project Description"),
})
if err != nil {
return err
}
return nil
})
}
resources:
project:
type: azuredevops:Project
properties:
name: Project Name
description: Project Description
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var project = new Project("project", ProjectArgs.builder()
.name("Project Name")
.description("Project Description")
.build());
}
}
Configuration Reference
The following configuration inputs are supported in the provider
block:
orgServiceUrl
- (Required) This is the Azure DevOps organization url. It can also be sourced from theAZDO_ORG_SERVICE_URL
environment variable.personalAccessToken
- This is the Azure DevOps organization personal access token. The account corresponding to the token will need “owner” privileges for this organization. It can also be sourced from theAZDO_PERSONAL_ACCESS_TOKEN
environment variable.clientId
- The client id used when authenticating to a service principal or the principal id when authenticating with a user specified managed service identity. It can also be sourced from theARM_CLIENT_ID
environment variable.tenantId
- The tenant id used when authenticating to a service principal. It can also be sourced from theARM_TENANT_ID
environment variable.clientIdPlan
- The client id used when authenticating to a service principal using the Pulumi Cloud workload identity token during a plan operation in Pulumi Cloud.clientId
may be used if the id is the same for plan & apply. It can also be sourced from theARM_CLIENT_ID_PLAN
environment variable.clientIdApply
- The client id used when authenticating to a service principal using the Pulumi Cloud workload identity token during an apply operation in Pulumi Cloud.clientId
may be used if the id is the same for plan & apply. It can also be sourced from theARM_CLIENT_ID_APPLY
environment variable.tenantIdPlan
- The tenant id used when authenticating to a service principal using the Pulumi Cloud workload identity token during a plan operation in Pulumi Cloud.tenantId
may be used if the id is the same for plan & apply. It can also be sourced from theARM_TENANT_ID_PLAN
environment variable.tenantIdApply
- The tenant id used when authenticating to a service principal using the Pulumi Cloud workload identity token during an apply operation in Pulumi Cloud.tenantId
may be used if the id is the same for plan & apply. It can also be sourced from theARM_TENANT_ID_APPLY
environment variable.clientSecret
- The client secret used to authenticate to a service principal. It can also be sourced from theARM_CLIENT_SECRET
environment variable.clientSecretPath
- The path to a file containing a client secret to authenticate to a service principal. It can also be sourced from theARM_CLIENT_SECRET_PATH
environment variable.oidcAudience
- Specifies the oidc audience to request when using anoidcRequestUrl
, most commonly with GitHub Actions. It can also be sourced from theARM_OIDC_AUDIENCE
environment variable.oidcRequestToken
- The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. It can also be sourced from theARM_OIDC_REQUEST_TOKEN
orACTIONS_ID_TOKEN_REQUEST_TOKEN
environment variables.oidcRequestUrl
- The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect. It can also be sourced from theARM_OIDC_REQUEST_URL
orACTIONS_ID_TOKEN_REQUEST_URL
environment variables.oidcTfcTag
- Pulumi Cloud dynamic credential provider tag. It can also be sourced from theARM_OIDC_TFC_TAG
environment variable.oidcToken
- An OIDC token to authenticate to a service principal. It can also be sourced from theARM_OIDC_TOKEN
environment variable.oidcTokenFilePath
- The path to a file containing nn OIDC token to authenticate to a service principal. It can also be sourced from theAZDO_TOKEN_PATH
environment variable.oidcGithubActions
- Boolean, set to true to use a GitHub Actions OIDC token to authenticate to a service principal. It can also be sourced from theARM_OIDC_GITHUB_ACTIONS
environment variable.oidcGithubActionsAudience
- Custom audience for the GitHub Actions OIDC token. It can also be sourced from theARM_OIDC_GITHUB_ACTIONS_AUDIENCE
environment variable.useOidc
- Boolean, enables OIDC auth methods. It can also be sourced from theARM_USE_OIDC
environment variable.useMsi
- Boolean, enables authentication with a Managed Service Identity in Azure. It can also be sourced from theARM_USE_MSI
environment variable.clientCertificatePath
- The path to a file containing a certificate to authenticate to a service principal, typically a .pfx file. It can also be sourced from theARM_CLIENT_CERTIFICATE_PATH
environment variable.clientCertificate
- A base64 encoded certificate to authentiate to a service principal. It can also be sourced from theARM_CLIENT_CERTIFICATE
environment variable.clientCertificatePassword
- This is the password associated with a certificate provided byclientCertificatePath
orclientCertificate
. It can also be sourced from theARM_CLIENT_CERTIFICATE_PASSWORD
environment variable.