AzureDevOpsDscNative

1.3.0-preview1

en-US/about_AzDoDashboard.help.txt

.NAME
    AzDoDashboard
 
.SYNOPSIS
    DSC resource for managing Azure DevOps dashboards.
 
.DESCRIPTION
    Manages the existence, description and refresh interval of a dashboard. A dashboard belongs
    either to a team (TeamName set) or to the project itself (TeamName omitted). The widgets on
    a dashboard are not managed - they are left as they are on every update.
 
.PARAMETER DashboardName
    Key - System.String
    The name of the dashboard. Unique within its team or project.
 
.PARAMETER ProjectName
    Required - System.String
    The name of the Azure DevOps project.
 
.PARAMETER TeamName
    Write - System.String
    The team that owns the dashboard, for example 'Contoso Team'. Omit for a project-scoped
    dashboard.
 
.PARAMETER Description
    Write - System.String
    A description of the dashboard. Left unmanaged when not specified.
 
.PARAMETER RefreshInterval
    Write - System.Int32
    The automatic refresh interval in minutes; 0 turns automatic refresh off. The service decides
    which intervals it accepts - the web UI offers off and 5 minutes. Left unmanaged when not
    specified.
 
.EXAMPLE 1
 
This example shows how to create a dashboard for a team in an existing project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoDashboard 'AddAzDoDashboard'
        {
            Ensure = 'Present'
            DashboardName = 'Sprint Overview'
            ProjectName = 'MyProject'
            TeamName = 'MyProject Team'
            Description = 'Burndown and open bugs for the current sprint'
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update the description and refresh interval of an
existing team dashboard. The widgets on the dashboard are left as they are.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoDashboard 'UpdateAzDoDashboard'
        {
            Ensure = 'Present'
            DashboardName = 'Sprint Overview'
            ProjectName = 'MyProject'
            TeamName = 'MyProject Team'
            Description = 'Burndown, velocity and open bugs for the current sprint'
            RefreshInterval = 5
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a team dashboard and the widgets on it.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoDashboard 'RemoveAzDoDashboard'
        {
            Ensure = 'Absent'
            DashboardName = 'Sprint Overview'
            ProjectName = 'MyProject'
            TeamName = 'MyProject Team'
        }
    }
}