Partager via

Admin - Pipelines GetPipelinesAsAdmin

Service:
Power BI REST APIs
Version d'API:
v1.0

Retourne une liste de pipelines de déploiement pour l’organisation.

Autorisations

L’utilisateur doit disposer de droits d’administrateur ou s’authentifier à l’aide d’un principal de service.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Limites

Maximum 200 requêtes par heure. 

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines
Avec des paramètres facultatifs: 
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

Paramètres URI

Nom Dans Obligatoire Type Description
$expand
 query

string

Accepte une liste séparée par des virgules de types de données, qui sera développée inline dans la réponse. Prend en charge users et stages.
$filter
 query

string

Filtre les résultats en fonction d’une condition booléenne. Cette API prend uniquement en charge le filtrage pour pipelines de déploiement orphelins. Les filtres non pris en charge retournent des résultats non filtrés.
$skip
 query

integer (int32)

Ignore les premiers n résultats. Utilisez avec le haut pour extraire les résultats au-delà des 5 000 premiers.
$top
 query

integer (int32)

minimum: 1
maximum: 5000

Retourne uniquement les n premiers résultats. Ce paramètre doit se trouver dans la plage de 1 à 5 000.

Réponses

Nom Type Description
200 OK

AdminPipelines

D’ACCORD

Exemples

Get deployment pipelines example
Get deployment pipelines with their 'stages' expanded example
Get deployment pipelines with their 'users' expanded example
Get orphaned deployment pipelines example

Get deployment pipelines example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports"
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports"
    }
  ]
}

Get deployment pipelines with their 'stages' expanded example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=stages&$top=100

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "stages": [
        {
          "order": "0",
          "workspaceId": "5dba60b0-d9a7-42a3-b12c-6d9d51e7739a",
          "workspaceName": "SQlAzure-Refresh"
        },
        {
          "order": "1",
          "workspaceId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "workspaceName": "SQlAzure-Refresh[Test]"
        },
        {
          "order": "2"
        }
      ]
    }
  ]
}

Get deployment pipelines with their 'users' expanded example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$top=100

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "users": [
        {
          "identifier": "john@contoso.com",
          "accessRight": "Admin",
          "principalType": "User"
        },
        {
          "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
          "accessRight": "Admin",
          "principalType": "Group"
        },
        {
          "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
          "accessRight": "Admin",
          "principalType": "App"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

Get orphaned deployment pipelines example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$filter=(not users/any())&$top=100

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

Définitions

Nom Description
AdminPipeline

Pipeline Power BI retourné par les API utilisateur
AdminPipelines

Wrapper de réponse OData pour une collection de pipelines de déploiement Power BI
PipelineStage

Étape du pipeline de déploiement Power BI
PipelineUser

Entrée de droit d’accès utilisateur Power BI pour un pipeline de déploiement
PipelineUserAccessRight

Obligatoire. Droit d’accès d’un utilisateur pour le pipeline de déploiement.
PrincipalType

Type de principal

AdminPipeline

Object

Pipeline Power BI retourné par les API utilisateur

Nom Type Description
description

string

Description du pipeline de déploiement
displayName

string

Nom d’affichage du pipeline de déploiement
id

string (uuid)

ID du pipeline de déploiement
stages

PipelineStage[]

Collection d’étapes de pipeline de déploiement. Retourné uniquement lorsque $expand est défini sur stages dans la requête.
users

PipelineUser[]

Collection d’utilisateurs de pipeline de déploiement. Retourné uniquement lorsque $expand est défini sur users dans la requête.

AdminPipelines

Object

Wrapper de réponse OData pour une collection de pipelines de déploiement Power BI

Nom Type Description
@odata.context

string

Contexte OData
value

AdminPipeline[]

Collection de pipelines de déploiement

PipelineStage

Object

Étape du pipeline de déploiement Power BI

Nom Type Description
order

integer

Ordre d’étape, à partir de zéro.
workspaceId

string (uuid)

ID d’espace de travail affecté. Applicable uniquement lorsqu’il existe un espace de travail affecté.
workspaceName

string

Nom de l’espace de travail affecté. Applicable uniquement lorsqu’il existe un espace de travail affecté et que l’utilisateur a accès à l’espace de travail.

PipelineUser

Object

Entrée de droit d’accès utilisateur Power BI pour un pipeline de déploiement

Nom Type Description
accessRight

PipelineUserAccessRight

Obligatoire. Droit d’accès d’un utilisateur pour le pipeline de déploiement.
identifier

string

Pour le type principal User, fournissez le UPN. Sinon, fournissez l’ID d’objet du principal.
principalType

PrincipalType

Type de principal

PipelineUserAccessRight

Énumération

Obligatoire. Droit d’accès d’un utilisateur pour le pipeline de déploiement.

Valeur Description
Admin

Octroie des droits d’administrateur à un pipeline de déploiement

PrincipalType

Énumération

Type de principal

Valeur Description
None

Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation.
User

Type de principal de l’utilisateur
Group

Type de principal de groupe
App

Type de principal de service