Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. Dashboard
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.Dashboard

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

    Manages Dashboard within Azure DevOps project.

    NOTE: Project level Dashboard allows to be created with the same name. Dashboard held by a team must have a different name.

    Example Usage

    Manage Project dashboard

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

const example = new azuredevops.Project("example", {
    name: "Example Project",
    description: "Managed by Pulumi",
});
const exampleDashboard = new azuredevops.Dashboard("example", {
    projectId: example.id,
    name: "Example dashboard",
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    name="Example Project",
    description="Managed by Pulumi")
example_dashboard = azuredevops.Dashboard("example",
    project_id=example.id,
    name="Example dashboard")

    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"),
			Description: pulumi.String("Managed by Pulumi"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewDashboard(ctx, "example", &azuredevops.DashboardArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Example dashboard"),
		})
		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",
        Description = "Managed by Pulumi",
    });

    var exampleDashboard = new AzureDevOps.Dashboard("example", new()
    {
        ProjectId = example.Id,
        Name = "Example dashboard",
    });

});

    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.Dashboard;
import com.pulumi.azuredevops.DashboardArgs;
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")
            .description("Managed by Pulumi")
            .build());

        var exampleDashboard = new Dashboard("exampleDashboard", DashboardArgs.builder()
            .projectId(example.id())
            .name("Example dashboard")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      description: Managed by Pulumi
  exampleDashboard:
    type: azuredevops:Dashboard
    name: example
    properties:
      projectId: ${example.id}
      name: Example dashboard

    Manage Team dashboard

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

const example = new azuredevops.Project("example", {
    name: "Example Project",
    description: "Managed by Pulumi",
});
const exampleTeam = new azuredevops.Team("example", {
    projectId: example.id,
    name: "Example team",
});
const exampleDashboard = new azuredevops.Dashboard("example", {
    projectId: example.id,
    name: "Example dashboard",
    teamId: exampleTeam.id,
});

    import pulumi
import pulumi_azuredevops as azuredevops

example = azuredevops.Project("example",
    name="Example Project",
    description="Managed by Pulumi")
example_team = azuredevops.Team("example",
    project_id=example.id,
    name="Example team")
example_dashboard = azuredevops.Dashboard("example",
    project_id=example.id,
    name="Example dashboard",
    team_id=example_team.id)

    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"),
			Description: pulumi.String("Managed by Pulumi"),
		})
		if err != nil {
			return err
		}
		exampleTeam, err := azuredevops.NewTeam(ctx, "example", &azuredevops.TeamArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Example team"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewDashboard(ctx, "example", &azuredevops.DashboardArgs{
			ProjectId: example.ID(),
			Name:      pulumi.String("Example dashboard"),
			TeamId:    exampleTeam.ID(),
		})
		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",
        Description = "Managed by Pulumi",
    });

    var exampleTeam = new AzureDevOps.Team("example", new()
    {
        ProjectId = example.Id,
        Name = "Example team",
    });

    var exampleDashboard = new AzureDevOps.Dashboard("example", new()
    {
        ProjectId = example.Id,
        Name = "Example dashboard",
        TeamId = exampleTeam.Id,
    });

});

    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.Team;
import com.pulumi.azuredevops.TeamArgs;
import com.pulumi.azuredevops.Dashboard;
import com.pulumi.azuredevops.DashboardArgs;
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")
            .description("Managed by Pulumi")
            .build());

        var exampleTeam = new Team("exampleTeam", TeamArgs.builder()
            .projectId(example.id())
            .name("Example team")
            .build());

        var exampleDashboard = new Dashboard("exampleDashboard", DashboardArgs.builder()
            .projectId(example.id())
            .name("Example dashboard")
            .teamId(exampleTeam.id())
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      description: Managed by Pulumi
  exampleTeam:
    type: azuredevops:Team
    name: example
    properties:
      projectId: ${example.id}
      name: Example team
  exampleDashboard:
    type: azuredevops:Dashboard
    name: example
    properties:
      projectId: ${example.id}
      name: Example dashboard
      teamId: ${exampleTeam.id}

    Create Dashboard Resource

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

    Constructor syntax

    new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
    @overload
def Dashboard(resource_name: str,
              args: DashboardArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              project_id: Optional[str] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              refresh_interval: Optional[int] = None,
              team_id: Optional[str] = None)
    func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)

    type: azuredevops:Dashboard
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 DashboardArgs
    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 DashboardArgs
    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 DashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardArgs
    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 dashboardResource = new AzureDevOps.Dashboard("dashboardResource", new()
{
    ProjectId = "string",
    Description = "string",
    Name = "string",
    RefreshInterval = 0,
    TeamId = "string",
});

    example, err := azuredevops.NewDashboard(ctx, "dashboardResource", &azuredevops.DashboardArgs{
	ProjectId:       pulumi.String("string"),
	Description:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	RefreshInterval: pulumi.Int(0),
	TeamId:          pulumi.String("string"),
})

    var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
    .projectId("string")
    .description("string")
    .name("string")
    .refreshInterval(0)
    .teamId("string")
    .build());

    dashboard_resource = azuredevops.Dashboard("dashboardResource",
    project_id="string",
    description="string",
    name="string",
    refresh_interval=0,
    team_id="string")

    const dashboardResource = new azuredevops.Dashboard("dashboardResource", {
    projectId: "string",
    description: "string",
    name: "string",
    refreshInterval: 0,
    teamId: "string",
});

    type: azuredevops:Dashboard
properties:
    description: string
    name: string
    projectId: string
    refreshInterval: 0
    teamId: string

    Dashboard 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 Dashboard resource accepts the following input properties:

    ProjectId string
    The ID of the Project. Changing this forces a new resource to be created.
    Description string
    The description of the dashboard.
    Name string
    The name of the Dashboard.
    RefreshInterval int
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    TeamId string
    The ID of the Team.
    ProjectId string
    The ID of the Project. Changing this forces a new resource to be created.
    Description string
    The description of the dashboard.
    Name string
    The name of the Dashboard.
    RefreshInterval int
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    TeamId string
    The ID of the Team.
    projectId String
    The ID of the Project. Changing this forces a new resource to be created.
    description String
    The description of the dashboard.
    name String
    The name of the Dashboard.
    refreshInterval Integer
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    teamId String
    The ID of the Team.
    projectId string
    The ID of the Project. Changing this forces a new resource to be created.
    description string
    The description of the dashboard.
    name string
    The name of the Dashboard.
    refreshInterval number
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    teamId string
    The ID of the Team.
    project_id str
    The ID of the Project. Changing this forces a new resource to be created.
    description str
    The description of the dashboard.
    name str
    The name of the Dashboard.
    refresh_interval int
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    team_id str
    The ID of the Team.
    projectId String
    The ID of the Project. Changing this forces a new resource to be created.
    description String
    The description of the dashboard.
    name String
    The name of the Dashboard.
    refreshInterval Number
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    teamId String
    The ID of the Team.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerId string
    The owner of the Dashboard, could be the project or a team.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerId string
    The owner of the Dashboard, could be the project or a team.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerId String
    The owner of the Dashboard, could be the project or a team.
    id string
    The provider-assigned unique ID for this managed resource.
    ownerId string
    The owner of the Dashboard, could be the project or a team.
    id str
    The provider-assigned unique ID for this managed resource.
    owner_id str
    The owner of the Dashboard, could be the project or a team.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerId String
    The owner of the Dashboard, could be the project or a team.

    Look up Existing Dashboard Resource

    Get an existing Dashboard 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?: DashboardState, opts?: CustomResourceOptions): Dashboard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        owner_id: Optional[str] = None,
        project_id: Optional[str] = None,
        refresh_interval: Optional[int] = None,
        team_id: Optional[str] = None) -> Dashboard
    func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
    public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
    public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:Dashboard    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
    The description of the dashboard.
    Name string
    The name of the Dashboard.
    OwnerId string
    The owner of the Dashboard, could be the project or a team.
    ProjectId string
    The ID of the Project. Changing this forces a new resource to be created.
    RefreshInterval int
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    TeamId string
    The ID of the Team.
    Description string
    The description of the dashboard.
    Name string
    The name of the Dashboard.
    OwnerId string
    The owner of the Dashboard, could be the project or a team.
    ProjectId string
    The ID of the Project. Changing this forces a new resource to be created.
    RefreshInterval int
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    TeamId string
    The ID of the Team.
    description String
    The description of the dashboard.
    name String
    The name of the Dashboard.
    ownerId String
    The owner of the Dashboard, could be the project or a team.
    projectId String
    The ID of the Project. Changing this forces a new resource to be created.
    refreshInterval Integer
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    teamId String
    The ID of the Team.
    description string
    The description of the dashboard.
    name string
    The name of the Dashboard.
    ownerId string
    The owner of the Dashboard, could be the project or a team.
    projectId string
    The ID of the Project. Changing this forces a new resource to be created.
    refreshInterval number
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    teamId string
    The ID of the Team.
    description str
    The description of the dashboard.
    name str
    The name of the Dashboard.
    owner_id str
    The owner of the Dashboard, could be the project or a team.
    project_id str
    The ID of the Project. Changing this forces a new resource to be created.
    refresh_interval int
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    team_id str
    The ID of the Team.
    description String
    The description of the dashboard.
    name String
    The name of the Dashboard.
    ownerId String
    The owner of the Dashboard, could be the project or a team.
    projectId String
    The ID of the Project. Changing this forces a new resource to be created.
    refreshInterval Number
    The interval for client to automatically refresh the dashboard. Expressed in minutes. Possible values are: 0, 5.Defaults to 0.
    teamId String
    The ID of the Team.

    Import

    Azure DevOps Dashboard can be imported using the projectId/dasboardId or projectId/teamId/dasboardId

    $ pulumi import azuredevops:index/dashboard:Dashboard dashboard 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000

    or

    $ pulumi import azuredevops:index/dashboard:Dashboard dashboard 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000

    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
    Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
    pulumi/pulumi-azuredevops