Aktivitetsreferens för Azure Pipelines

En uppgift utför en åtgärd i en pipeline. En uppgift kan till exempel skapa en app, interagera med Azure-resurser, installera ett verktyg eller köra ett test. Uppgifter är byggstenarna för att definiera automatisering i en pipeline.

Artiklarna i det här avsnittet beskriver de inbyggda uppgifterna för Azure Pipelines och anger semantiken för attribut som har särskild betydelse för varje aktivitet.

Mer information om de allmänna attribut som stöds av aktiviteter finns i YAML-referens för steps.task.

Anvisningar och självstudier om hur du redigerar pipelines med hjälp av uppgifter, inklusive att skapa anpassade uppgifter, anpassade tillägg och hitta uppgifter på Visual Studio Marketplace finns i Tasks-begrepp och Dokumentation om Azure Pipelines.

Öppen källkod

Dessa uppgifter är med öppen källkod på GitHub. Feedback och bidrag är välkomna. Se Ändringslogg för pipelineaktivitet för en lista över aktivitetsändringar, inklusive en historisk post med aktivitetsuppdateringar.

FAQ

Vad är aktivitetsindataalias?

Indata till en uppgift identifieras av en label, nameoch kan innehålla en eller flera valfria aliases. Följande exempel är ett utdrag från källkod för posten kända värdar indata för InstallSSHKey@0 uppgiften.

{
    "name": "hostName",
    "aliases": [
        "knownHostsEntry"
    ],
    "label": "Known Hosts Entry"
    ...
}

Innan YAML-pipelines introducerades 2019 skapades och redigerades pipelines med hjälp av en UI-baserad pipelineredigerare, och endast label användes av pipelineförfattare för att referera till en uppgiftsinmatning.

När YAML-pipelines introducerades 2019 började pipelineförfattare med YAML använda uppgiftsindata name för att referera till en uppgiftsinmatning. I vissa fall var uppgiftsindatanamnen inte beskrivande, så aliases lades till för att ge ytterligare beskrivande namn för uppgiftsindata.

Uppgiften InstallSSHKey@0 har till exempel en kända värdpost indata med namnet hostName som förväntar sig en post från en known_hosts fil. Etiketten Kända värdar i den klassiska pipelinedesignern gör detta tydligt, men det är inte lika tydligt när du använder hostName namn i en YAML-pipeline. Aktivitetsindataalias introducerades för att göra det möjligt för aktivitetsförfattare att ange dekritiska namn för sina tidigare redigerade uppgifter, och för InstallSSHKey@0 uppgift lades ett knownHostsEntryalias till, samtidigt som det ursprungliga hostName namnet för kompatibilitet med befintliga pipelines med det namnet.

Alla objekt i en aktivitetsindatas aliases är utbytbara med name i en YAML-pipeline. Följande två YAML-kodfragment är funktionellt identiska, med det första exemplet med hjälp av knownHostsEntry alias och det andra exemplet med hostName.

- task: InstallSSHKey@0
  inputs:
    # Using knownHostsEntry alias
    knownHostsEntry: 'sample known hosts entry line'
    # Remainder of task inputs omitted

- task: InstallSSHKey@0
  inputs:
    # Using hostName name
    hostName: 'sample known hosts entry line'
    # Remainder of task inputs omitted

Från och med Azure DevOps Server 2019.1 introducerades YAML-pipelineredigeraren, som tillhandahåller en intellisense-typfunktionalitet.

YAML-pipelineredigeraren använder Yamlschema – Get REST API för att hämta schemat som används för validering i redigeraren. Om en aktivitetsindata har ett alias höjer schemat aliaset till det primära YAML-namnet för aktivitetsindata och aliaset föreslås av intellisense.

Följande exempel är posten Kända värdar uppgiftsindata för InstallSSHKey@0 aktivitet från YAML-schemat, där knownHostsEntry anges i namnpositionen och hostName i aliases-samlingen.

"properties": {
    "knownHostsEntry": {
      "type": "string",
      "description": "Known Hosts Entry",
      "ignoreCase": "key",
      "aliases": [
        "hostName"
      ]
    },

Eftersom intellisense i YAML-pipelineredigeraren visar knownHostsEntry, och YAML som genereras av aktivitetsassistenten använder knownHostsEntry i den genererade YAML, visar aktivitetsreferensen alias från uppgiftskällans kod som YAML-namn för en aktivitetsinmatning. Om en aktivitet har fler än ett alias (det finns några som har två alias) används det första aliaset som namn.

Varför ändrades uppgiftsreferensen?

Referensdokumentationen för Azure Pipelines-uppgifter har flyttats till den aktuella platsen för att stödja följande förbättringar.

• Aktivitetsartiklar genereras med hjälp av uppgiftskällans kod från Azure Pipelines-uppgifter med öppen källkod.
• Uppgiftsindatanamn och alias genereras från aktivitetskällan så att de alltid är uppdaterade.
• YAML-syntaxblock genereras från aktivitetskällan så att de är uppdaterade.
• Stöder community-bidrag med integrerat användarinnehåll, till exempel förbättrade beskrivningar av uppgiftsindata, kommentarer och exempel.
• Ger uppgiftstäckning för alla Azure DevOps-versioner som stöds.
• Uppdaterade varje sprint för att täcka de senaste uppdateringarna.

Information om hur du bidrar finns i Bidra till aktiviteternas innehåll.

Var kan jag lära mig steg för steg hur jag skapar min app?

Skapa din app

Kan jag lägga till mina egna bygguppgifter?

Ja: Lägg till en bygguppgift

Vad är installationsaktiviteter?

Mer information om installationsuppgifter för verktyg finns i Installationsprogram för verktyg.