Dashboard.yml

### YamlMime:TSType
name: Dashboard
uid: azure-devops-extension-api.Dashboard
package: azure-devops-extension-api
summary: Model of a Dashboard.
fullName: Dashboard
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: dashboardScope
    uid: azure-devops-extension-api.Dashboard.dashboardScope
    package: azure-devops-extension-api
    summary: Entity to which the dashboard is scoped.
    fullName: dashboardScope
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'dashboardScope: DashboardScope'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.DashboardScope" />
  - name: description
    uid: azure-devops-extension-api.Dashboard.description
    package: azure-devops-extension-api
    summary: Description of the dashboard.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description: string'
      return:
        description: ''
        type: string
  - name: eTag
    uid: azure-devops-extension-api.Dashboard.eTag
    package: azure-devops-extension-api
    summary: Server defined version tracking value, used for edit collision detection.
    fullName: eTag
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'eTag: string'
      return:
        description: ''
        type: string
  - name: globalParametersConfig
    uid: azure-devops-extension-api.Dashboard.globalParametersConfig
    package: azure-devops-extension-api
    summary: Dashboard Global Parameters Config
    fullName: globalParametersConfig
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'globalParametersConfig: string'
      return:
        description: ''
        type: string
  - name: groupId
    uid: azure-devops-extension-api.Dashboard.groupId
    package: azure-devops-extension-api
    summary: >-
      ID of the group for a dashboard. For team-scoped dashboards, this is the
      unique identifier for the team associated with the dashboard. For
      project-scoped dashboards this property is empty.
    fullName: groupId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'groupId: string'
      return:
        description: ''
        type: string
  - name: id
    uid: azure-devops-extension-api.Dashboard.id
    package: azure-devops-extension-api
    summary: ID of the Dashboard. Provided by service at creation time.
    fullName: id
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'id: string'
      return:
        description: ''
        type: string
  - name: lastAccessedDate
    uid: azure-devops-extension-api.Dashboard.lastAccessedDate
    package: azure-devops-extension-api
    summary: Dashboard Last Accessed Date.
    fullName: lastAccessedDate
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'lastAccessedDate: Date'
      return:
        description: ''
        type: Date
  - name: modifiedBy
    uid: azure-devops-extension-api.Dashboard.modifiedBy
    package: azure-devops-extension-api
    summary: Id of the person who modified Dashboard.
    fullName: modifiedBy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'modifiedBy: string'
      return:
        description: ''
        type: string
  - name: modifiedDate
    uid: azure-devops-extension-api.Dashboard.modifiedDate
    package: azure-devops-extension-api
    summary: Dashboard's last modified date.
    fullName: modifiedDate
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'modifiedDate: Date'
      return:
        description: ''
        type: Date
  - name: name
    uid: azure-devops-extension-api.Dashboard.name
    package: azure-devops-extension-api
    summary: Name of the Dashboard.
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name: string'
      return:
        description: ''
        type: string
  - name: ownerId
    uid: azure-devops-extension-api.Dashboard.ownerId
    package: azure-devops-extension-api
    summary: >-
      ID of the owner for a dashboard. For team-scoped dashboards, this is the
      unique identifier for the team associated with the dashboard. For
      project-scoped dashboards, this is the unique identifier for the user
      identity associated with the dashboard.
    fullName: ownerId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'ownerId: string'
      return:
        description: ''
        type: string
  - name: position
    uid: azure-devops-extension-api.Dashboard.position
    package: azure-devops-extension-api
    summary: >-
      Position of the dashboard, within a dashboard group. If unset at creation
      time, position is decided by the service.
    fullName: position
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'position: number'
      return:
        description: ''
        type: number
  - name: refreshInterval
    uid: azure-devops-extension-api.Dashboard.refreshInterval
    package: azure-devops-extension-api
    summary: >-
      Interval for client to automatically refresh the dashboard. Expressed in
      minutes.
    fullName: refreshInterval
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'refreshInterval: number'
      return:
        description: ''
        type: number
  - name: url
    uid: azure-devops-extension-api.Dashboard.url
    package: azure-devops-extension-api
    summary: ''
    fullName: url
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'url: string'
      return:
        description: ''
        type: string
  - name: widgets
    uid: azure-devops-extension-api.Dashboard.widgets
    package: azure-devops-extension-api
    summary: The set of Widgets on the dashboard.
    fullName: widgets
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'widgets: Widget[]'
      return:
        description: ''
        type: <xref uid="azure-devops-extension-api.Widget" />[]