1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. DeploymentGroup
Viewing docs for Azure DevOps v3.14.0
published on Tuesday, Mar 24, 2026 by Pulumi
azuredevops logo
Viewing docs for Azure DevOps v3.14.0
published on Tuesday, Mar 24, 2026 by Pulumi

    Manages a Deployment Group used by classic release pipelines.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azuredevops from "@pulumi/azuredevops";
    
    const example = new azuredevops.Project("example", {
        name: "Example Project",
        workItemTemplate: "Agile",
        versionControl: "Git",
        visibility: "private",
        description: "Managed by Pulumi",
    });
    const exampleDeploymentGroup = new azuredevops.DeploymentGroup("example", {
        projectId: example.id,
        name: "Example Deployment Group",
        description: "Managed by Pulumi",
    });
    
    import pulumi
    import pulumi_azuredevops as azuredevops
    
    example = azuredevops.Project("example",
        name="Example Project",
        work_item_template="Agile",
        version_control="Git",
        visibility="private",
        description="Managed by Pulumi")
    example_deployment_group = azuredevops.DeploymentGroup("example",
        project_id=example.id,
        name="Example Deployment Group",
        description="Managed by Pulumi")
    
    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 {
    		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
    			Name:             pulumi.String("Example Project"),
    			WorkItemTemplate: pulumi.String("Agile"),
    			VersionControl:   pulumi.String("Git"),
    			Visibility:       pulumi.String("private"),
    			Description:      pulumi.String("Managed by Pulumi"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = azuredevops.NewDeploymentGroup(ctx, "example", &azuredevops.DeploymentGroupArgs{
    			ProjectId:   example.ID(),
    			Name:        pulumi.String("Example Deployment Group"),
    			Description: pulumi.String("Managed by Pulumi"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureDevOps = Pulumi.AzureDevOps;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AzureDevOps.Project("example", new()
        {
            Name = "Example Project",
            WorkItemTemplate = "Agile",
            VersionControl = "Git",
            Visibility = "private",
            Description = "Managed by Pulumi",
        });
    
        var exampleDeploymentGroup = new AzureDevOps.DeploymentGroup("example", new()
        {
            ProjectId = example.Id,
            Name = "Example Deployment Group",
            Description = "Managed by Pulumi",
        });
    
    });
    
    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 com.pulumi.azuredevops.DeploymentGroup;
    import com.pulumi.azuredevops.DeploymentGroupArgs;
    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 example = new Project("example", ProjectArgs.builder()
                .name("Example Project")
                .workItemTemplate("Agile")
                .versionControl("Git")
                .visibility("private")
                .description("Managed by Pulumi")
                .build());
    
            var exampleDeploymentGroup = new DeploymentGroup("exampleDeploymentGroup", DeploymentGroupArgs.builder()
                .projectId(example.id())
                .name("Example Deployment Group")
                .description("Managed by Pulumi")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azuredevops:Project
        properties:
          name: Example Project
          workItemTemplate: Agile
          versionControl: Git
          visibility: private
          description: Managed by Pulumi
      exampleDeploymentGroup:
        type: azuredevops:DeploymentGroup
        name: example
        properties:
          projectId: ${example.id}
          name: Example Deployment Group
          description: Managed by Pulumi
    

    Create DeploymentGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DeploymentGroup(name: string, args: DeploymentGroupArgs, opts?: CustomResourceOptions);
    @overload
    def DeploymentGroup(resource_name: str,
                        args: DeploymentGroupArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def DeploymentGroup(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        project_id: Optional[str] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        pool_id: Optional[int] = None)
    func NewDeploymentGroup(ctx *Context, name string, args DeploymentGroupArgs, opts ...ResourceOption) (*DeploymentGroup, error)
    public DeploymentGroup(string name, DeploymentGroupArgs args, CustomResourceOptions? opts = null)
    public DeploymentGroup(String name, DeploymentGroupArgs args)
    public DeploymentGroup(String name, DeploymentGroupArgs args, CustomResourceOptions options)
    
    type: azuredevops:DeploymentGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DeploymentGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeploymentGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeploymentGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var deploymentGroupResource = new AzureDevOps.DeploymentGroup("deploymentGroupResource", new()
    {
        ProjectId = "string",
        Description = "string",
        Name = "string",
        PoolId = 0,
    });
    
    example, err := azuredevops.NewDeploymentGroup(ctx, "deploymentGroupResource", &azuredevops.DeploymentGroupArgs{
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	PoolId:      pulumi.Int(0),
    })
    
    var deploymentGroupResource = new DeploymentGroup("deploymentGroupResource", DeploymentGroupArgs.builder()
        .projectId("string")
        .description("string")
        .name("string")
        .poolId(0)
        .build());
    
    deployment_group_resource = azuredevops.DeploymentGroup("deploymentGroupResource",
        project_id="string",
        description="string",
        name="string",
        pool_id=0)
    
    const deploymentGroupResource = new azuredevops.DeploymentGroup("deploymentGroupResource", {
        projectId: "string",
        description: "string",
        name: "string",
        poolId: 0,
    });
    
    type: azuredevops:DeploymentGroup
    properties:
        description: string
        name: string
        poolId: 0
        projectId: string
    

    DeploymentGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DeploymentGroup resource accepts the following input properties:

    ProjectId string
    The ID of the project. Changing this forces a new Deployment Group to be created.
    Description string
    A description for the Deployment Group. Defaults to "".
    Name string
    The name of the Deployment Group.
    PoolId int
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    ProjectId string
    The ID of the project. Changing this forces a new Deployment Group to be created.
    Description string
    A description for the Deployment Group. Defaults to "".
    Name string
    The name of the Deployment Group.
    PoolId int
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    projectId String
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description String
    A description for the Deployment Group. Defaults to "".
    name String
    The name of the Deployment Group.
    poolId Integer
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    projectId string
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description string
    A description for the Deployment Group. Defaults to "".
    name string
    The name of the Deployment Group.
    poolId number
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    project_id str
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description str
    A description for the Deployment Group. Defaults to "".
    name str
    The name of the Deployment Group.
    pool_id int
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    projectId String
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description String
    A description for the Deployment Group. Defaults to "".
    name String
    The name of the Deployment Group.
    poolId Number
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DeploymentGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    MachineCount int
    The number of deployment targets in the Deployment Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    MachineCount int
    The number of deployment targets in the Deployment Group.
    id String
    The provider-assigned unique ID for this managed resource.
    machineCount Integer
    The number of deployment targets in the Deployment Group.
    id string
    The provider-assigned unique ID for this managed resource.
    machineCount number
    The number of deployment targets in the Deployment Group.
    id str
    The provider-assigned unique ID for this managed resource.
    machine_count int
    The number of deployment targets in the Deployment Group.
    id String
    The provider-assigned unique ID for this managed resource.
    machineCount Number
    The number of deployment targets in the Deployment Group.

    Look up Existing DeploymentGroup Resource

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

    public static get(name: string, id: Input<ID>, state?: DeploymentGroupState, opts?: CustomResourceOptions): DeploymentGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            machine_count: Optional[int] = None,
            name: Optional[str] = None,
            pool_id: Optional[int] = None,
            project_id: Optional[str] = None) -> DeploymentGroup
    func GetDeploymentGroup(ctx *Context, name string, id IDInput, state *DeploymentGroupState, opts ...ResourceOption) (*DeploymentGroup, error)
    public static DeploymentGroup Get(string name, Input<string> id, DeploymentGroupState? state, CustomResourceOptions? opts = null)
    public static DeploymentGroup get(String name, Output<String> id, DeploymentGroupState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:DeploymentGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    A description for the Deployment Group. Defaults to "".
    MachineCount int
    The number of deployment targets in the Deployment Group.
    Name string
    The name of the Deployment Group.
    PoolId int
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    ProjectId string
    The ID of the project. Changing this forces a new Deployment Group to be created.
    Description string
    A description for the Deployment Group. Defaults to "".
    MachineCount int
    The number of deployment targets in the Deployment Group.
    Name string
    The name of the Deployment Group.
    PoolId int
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    ProjectId string
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description String
    A description for the Deployment Group. Defaults to "".
    machineCount Integer
    The number of deployment targets in the Deployment Group.
    name String
    The name of the Deployment Group.
    poolId Integer
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    projectId String
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description string
    A description for the Deployment Group. Defaults to "".
    machineCount number
    The number of deployment targets in the Deployment Group.
    name string
    The name of the Deployment Group.
    poolId number
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    projectId string
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description str
    A description for the Deployment Group. Defaults to "".
    machine_count int
    The number of deployment targets in the Deployment Group.
    name str
    The name of the Deployment Group.
    pool_id int
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    project_id str
    The ID of the project. Changing this forces a new Deployment Group to be created.
    description String
    A description for the Deployment Group. Defaults to "".
    machineCount Number
    The number of deployment targets in the Deployment Group.
    name String
    The name of the Deployment Group.
    poolId Number
    The ID of the deployment pool in which deployment agents are registered. If not specified, a new pool will be created. Changing this forces a new Deployment Group to be created.
    projectId String
    The ID of the project. Changing this forces a new Deployment Group to be created.

    Import

    Azure DevOps Deployment Groups can be imported using the project ID and deployment group ID, e.g.:

    $ pulumi import azuredevops:index/deploymentGroup:DeploymentGroup example 00000000-0000-0000-0000-000000000000/0
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Viewing docs for Azure DevOps v3.14.0
    published on Tuesday, Mar 24, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.