Exécuter une API Azure DevOps

L’action Azure DevOps API vous permet d’appeler n’importe quelle API REST Azure DevOps directement depuis vos workflows, sans nécessiter d’action dédiée pour chaque opération.

Cette action vous permet d’exécuter toute opération documentée dans la référence de l’API REST Azure DevOps. Indiquez l'organisation, le chemin de l'API, la méthode HTTP, et le corps de la requête facultatif : l'action gère automatiquement l'authentification.

Les entrées suivantes sont disponibles pour cette action :

Champ de saisie	optionnalité	Type	Description
`clientId`	Requis	Chaîne	Un clientId de principal de service Azure (format UUID). Transmettez en tant que secret. Voir comment inscrire une application Azure.
`clientSecret`	Requis	Chaîne	Un clientSecret de principal de service Azure. Passer en tant que secret. Voir comment inscrire une application Azure.
`tenantId`	Requis	Chaîne	L’identifiant de locataire Azure (format UUID). Vous pouvez le transmettre en tant que secret.
`organization`	Requis	Chaîne	Le nom de l’organisation Azure DevOps. Exemple : `"myOrganization"`
`urlPath`	Requis	Chaîne	Le chemin de l’URL pour la requête d’ API REST Azure DevOps (longueur maximale 1000). Exemple : `"/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.0"`
`method`	Requis	Chaîne	Un de [ `"GET", "POST", "PUT", "PATCH", "DELETE"` ]
`body`	Facultatif	Carte	Un corps facultatif sous forme de map JSON. Passez-le avec les méthodes `PUT` , `PATCH` , et `POST` lorsque la requête nécessite un corps. Prend en charge les références secrètes.
`selectors`	Facultatif	List	Une liste d'expressions JQ pour extraire des valeurs de la réponse. Chaque sélecteur associe un nom à une expression JQ. Exemple : `[{"name": "pipelineId", "expression": ".response.id"}]`

Cette action renvoie les sorties suivantes :

Champ de sortie	Type	Description
`success`	Booléen	`success: true \| false`
`errorMessage`	Chaîne	Contient la raison de l’échec si l’action échoue.
`response`	Objet	`<azure devops api body response>` Chaque point de terminaison d’API retourne une réponse différente. Consultez la référence de l’API REST Azure DevOps.
`asyncResponseUrl`	Chaîne	L’URL à interroger pour les opérations asynchrones. Lisez `status` ou `state` à partir de `response` pour suivre l’achèvement.
`retryAfterSeconds`	Entier	Temps d’attente en secondes que le serveur recommande avant de réessayer ou d’interroger l’URL asynchrone.

Exemple : obtenir les projets

- name: getProjects
    type: action
    action: azure.devops.api
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      organization: ${{ :secrets:organization }}
      urlPath: _apis/projects
      method: GET

Exemple : créer un pipeline

- name: createPipeline
    type: action
    action: azure.devops.api
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      organization: ${{ :secrets:organization }}
      urlPath: myProject/_apis/pipelines?api-version=7.1
      method: POST
      body:
        name: testPipeline
        folder: \
        configuration:
          type: yaml
          path: pipelineConfig.yml
          repository:
            id: 1a8bcfa4-1412-4b3b-af36-4ff1aa5860a1
            name: testRepository
            type: azureReposGit
      selectors:
        - name: pipelineId
          expression: .response.id
        - name: pipelineName
          expression: .response.name

Exemple : exécuter un pipeline

- name: runPipeline
    type: action
    action: azure.devops.api
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      organization: ${{ :secrets:organization }}
      urlPath: myProject/_apis/pipelines/1/runs?api-version=7.1-preview.1
      method: POST
      body:
        resources: {}
        variables: {}

Exemple : supprimer un pipeline

- name: deletePipeline
    type: action
    action: azure.devops.api
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      organization: ${{ :secrets:organization }}
      urlPath: myProject/_apis/build/definitions/1?api-version=7.1-preview.7
      method: DELETE

Cette traduction automatique est fournie pour votre commodité.

Exécuter une API Azure DevOps