如何通过 azure-devops-python-api 获取仪表板列表

Question

I am trying to get a list of dashboards using azure-devops-python-api . I can't figure out how to connect the libraries correctly to get the list of dashboards and work with them. What I've done is this:

from azure.devops.connection import Connection
from msrest.authentication import BasicAuthentication
from azure.devops.v6_0 import DashboardClient 
import pprint
import requests
import json

personal_access_token = 'PAT'
organization_url = 'https://dev.azure.com/Orgname/'
team_context = 'Orgname'
# Create a connection to the org
credentials = BasicAuthentication('', personal_access_token)
connection = Connection(base_url=organization_url, creds=credentials)

dashboard_resp = DashboardClient(base_url=organization_url, creds=credentials)
dashboards = dashboard_resp.get_dashboards_by_project('', team_context)

When I try to execute this code, I get an error

Traceback (most recent call last):
  File "az-dev-dash.py", line 16, in <module>
    dashboard_resp = azure.DashboardClient(base_url=organization_url, creds=credentials)
AttributeError: module 'azure.devops.v6_0' has no attribute 'DashboardClient'

Answer 1

You can use the below Python script to list the dashboards in a particular project using python.

Here is the python code:

from re import T
from azure.devops.connection import Connection
from azure.devops.v6_0.dashboard.models import Dashboard, TeamContext
from msrest.authentication import BasicAuthentication
from azure.devops.v6_0.dashboard.dashboard_client import DashboardClient 
import pprint
import requests
import json

personal_access_token = '<PATToken>'
organization_url = 'https://dev.azure.com/<OrgnName>' ##OrganisationalUrl

team_context=TeamContext('<projectName>')

# Create a connection to the org
credentials = BasicAuthentication('', personal_access_token)
connection = Connection(base_url=organization_url, creds=credentials)
core_client = connection.clients.get_core_client()
dashboard_resp = DashboardClient(base_url=organization_url, creds=credentials)
dashboards = dashboard_resp.get_dashboards_by_project(team_context)
for item in dashboards:
 print(item)

Here is the sample output for reference:

Alternatively, you can this Rest API, to list the dashboards in the project .