1. Docs
  2. Reference
  3. API
  4. @pulumi/azuredevops
  5. Pipeline

Module Pipeline

This page documents the language specification for the azuredevops package. If you're looking for help working with the inputs, outputs, or functions of azuredevops resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource VariableGroup

class VariableGroup extends CustomResource

Manages variable groups within Azure DevOps.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const project = new azuredevops.Core.Project("project", {projectName: "Test Project"});
const variablegroup = new azuredevops.Pipeline.VariableGroup("variablegroup", {
    projectId: project.id,
    description: "Test Variable Group Description",
    allowAccess: true,
    variable: [
        {
            name: "key",
            value: "value",
        },
        {
            name: "Account Password",
            value: "p@ssword123",
            isSecret: true,
        },
    ],
});

PAT Permissions Required

  • Variable Groups: Read, Create, & Manage

constructor

new VariableGroup(name: string, args: VariableGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a VariableGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VariableGroupState, opts?: pulumi.CustomResourceOptions): VariableGroup

Get an existing VariableGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VariableGroup

Returns true if the given object is an instance of VariableGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowAccess

public allowAccess: pulumi.Output<boolean | undefined>;

Boolean that indicate if this variable group is shared by all pipelines of this project.

property description

public description: pulumi.Output<string | undefined>;

The description of the Variable Group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keyVault

public keyVault: pulumi.Output<VariableGroupKeyVault | undefined>;

property name

public name: pulumi.Output<string>;

The name of the Variable Group.

property projectId

public projectId: pulumi.Output<string>;

The project ID or project name.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property variables

public variables: pulumi.Output<VariableGroupVariable[]>;

One or more variable blocks as documented below.

Others

interface VariableGroupArgs

interface VariableGroupArgs

The set of arguments for constructing a VariableGroup resource.

property allowAccess

allowAccess?: pulumi.Input<boolean>;

Boolean that indicate if this variable group is shared by all pipelines of this project.

property description

description?: pulumi.Input<string>;

The description of the Variable Group.

property keyVault

keyVault?: pulumi.Input<VariableGroupKeyVault>;

property name

name?: pulumi.Input<string>;

The name of the Variable Group.

property projectId

projectId: pulumi.Input<string>;

The project ID or project name.

property variables

variables: pulumi.Input<pulumi.Input<VariableGroupVariable>[]>;

One or more variable blocks as documented below.

interface VariableGroupState

interface VariableGroupState

Input properties used for looking up and filtering VariableGroup resources.

property allowAccess

allowAccess?: pulumi.Input<boolean>;

Boolean that indicate if this variable group is shared by all pipelines of this project.

property description

description?: pulumi.Input<string>;

The description of the Variable Group.

property keyVault

keyVault?: pulumi.Input<VariableGroupKeyVault>;

property name

name?: pulumi.Input<string>;

The name of the Variable Group.

property projectId

projectId?: pulumi.Input<string>;

The project ID or project name.

property variables

variables?: pulumi.Input<pulumi.Input<VariableGroupVariable>[]>;

One or more variable blocks as documented below.