Informazioni di riferimento sullo schema YAML per Azure Pipelines

Le informazioni di riferimento sullo schema YAML per Azure Pipelines sono un riferimento dettagliato per le pipeline YAML che elencano tutte le sintassi YAML supportate e le relative opzioni disponibili.

Per creare una pipeline YAML, iniziare con la definizione della pipeline . Per altre informazioni sulla creazione di pipeline YAML, vedere Personalizzare la pipeline.

Il riferimento allo schema YAML non copre le attività. Per altre informazioni sulle attività, vedere l'indice delle attività di Azure Pipelines.

Definizioni

Pipeline
Una pipeline è una o più fasi che descrivono un processo CI/CD. La definizione della pipeline contiene la documentazione per le proprietà a livello radice, ad esempio name.

Si estende
Estende una pipeline usando un modello.

Lavori
Specifica i processi che costituiscono il lavoro di una fase.

jobs.deployment
Un processo di distribuzione è un tipo speciale di processo. Si tratta di una raccolta di passaggi da eseguire in sequenza sull'ambiente.

jobs.deployment.environment
Nome dell'ambiente di destinazione e facoltativamente un nome di risorsa per registrare la cronologia di distribuzione; format: environment-name.resource-name.

jobs.deployment.strategy
Strategia di esecuzione per questa distribuzione.

jobs.deployment.strategy.canary
Strategia di distribuzione Canary.

jobs.deployment.strategy.rolling
Strategia di distribuzione in sequenza.

jobs.deployment.strategy.runOnce
Strategia di distribuzione RunOnce.

jobs.job
Un processo è una raccolta di passaggi eseguiti da un agente o in un server.

jobs.job.container
Nome risorsa contenitore.

jobs.job.strategy
Strategia di esecuzione per questo processo.

jobs.job.uses
Tutte le risorse richieste da questo processo a cui non è già fatto riferimento.

jobs.template
Set di processi definiti in un modello.

Parametri
Specifica i parametri di runtime passati a una pipeline.

parameters.parameter
Parametri del modello di pipeline.

Piscina
Pool da usare per un processo della pipeline.

pool.demands
Richieste (per un pool privato).

Pr
Trigger della richiesta pull.

Risorse
Le risorse specificano compilazioni, repository, pipeline e altre risorse usate dalla pipeline.

resources.build
Elenco di risorse di compilazione a cui fa riferimento la pipeline.

resources.build.build
Risorsa di compilazione usata per fare riferimento agli artefatti di un'esecuzione.

resources.containers
Elenco di immagini del contenitore.

resources.containers.container
Risorsa contenitore usata per fare riferimento a un'immagine del contenitore.

resources.containers.container.trigger
Specificare nessuno per disabilitare, true per attivare tutti i tag di immagine o usare la sintassi completa, come descritto negli esempi seguenti.

resources.packages
Elenco delle risorse del pacchetto.

resources.packages.package
Risorsa pacchetto usata per fare riferimento a un pacchetto GitHub NuGet o npm.

resources.pipelines
Elenco di risorse della pipeline.

resources.pipelines.pipeline
Una risorsa della pipeline.

resources.pipelines.pipeline.trigger
Specificare nessuno per disabilitare, true per includere tutti i rami o usare la sintassi completa, come descritto negli esempi seguenti.

resources.pipelines.pipeline.trigger.branches
Rami da includere o escludere per l'attivazione di un'esecuzione.

resources.repository
Elenco delle risorse del repository.

resources.repository.repository
Una risorsa del repository viene usata per fare riferimento a un repository aggiuntivo nella pipeline.

resources.webhooks
Elenco di webhook.

resources.webhooks.webhook
Una risorsa webhook consente di integrare la pipeline con un servizio esterno per automatizzare il flusso di lavoro.

resources.webhooks.webhook.filters
Elenco di filtri trigger.

resources.webhooks.webhook.filters.filter
Filtro trigger risorsa webhook.

Orari
L'elenco delle pianificazioni specifica i trigger pianificati per la pipeline.

schedules.cron
Un trigger pianificato specifica una pianificazione in base alla quale vengono compilati i rami.

Fasi
Le fasi sono una raccolta di processi correlati.

stages.stage
Una fase è una raccolta di processi correlati.

stages.template
È possibile definire un set di fasi in un file e usarlo più volte in altri file.

Passi
I passaggi sono una sequenza lineare di operazioni che costituiscono un processo.

steps.bash
Esegue uno script in Bash in Windows, macOS e Linux.

steps.checkout
Configurare il modo in cui la pipeline esegue il controllo del codice sorgente.

steps.download
Scarica gli artefatti associati all'esecuzione corrente o da un'altra pipeline di Azure associata come risorsa della pipeline.

steps.downloadBuild
Scarica gli artefatti di compilazione.

steps.getPackage
Scarica un pacchetto da un feed di gestione pacchetti in Elementi di Azure o Azure DevOps Server.

steps.powershell
Esegue uno script usando Windows PowerShell (in Windows) o pwsh (Linux e macOS).

steps.publish
Pubblica (caricamenti) un file o una cartella come artefatto della pipeline che altri processi e pipeline possono usare.

steps.pwsh
Esegue uno script in PowerShell Core in Windows, macOS e Linux.

steps.reviewApp
I download creano una risorsa in modo dinamico in un provider di fasi di distribuzione.

steps.script
Esegue uno script usando cmd.exe in Windows e Bash in altre piattaforme.

steps.task
Esegue un'attività.

steps.template
Definire un set di passaggi in un file e usarlo più volte in un altro file.

bersaglio
Le attività vengono eseguite in un contesto di esecuzione, ovvero l'host dell'agente o un contenitore.

target.settableVariables
Restrizioni sulle variabili che possono essere impostate.

Grilletto
Trigger di integrazione continua (push).

Variabili
Definire le variabili usando coppie nome/valore.

variables.group
Variabili di riferimento da un gruppo di variabili.

variables.name
Definire le variabili usando il nome e la sintassi completa.

variables.template
Definire le variabili in un modello.

Definizioni di supporto

Nota

Le definizioni di supporto non sono destinate all'uso direttamente in una pipeline. Le definizioni di supporto vengono usate solo come parte di altre definizioni e sono incluse qui per riferimento.

deployHook
Usato per eseguire i passaggi che distribuiscono l'applicazione.

includeExcludeFilters
Elenchi di elementi da includere o escludere.

includeExcludeStringFilters
Elementi da includere o escludere.

mountReadOnly
I volumi da montare in sola lettura, il valore predefinito è tutto false.

onFailureHook
Usato per eseguire i passaggi per eseguire azioni di rollback o pulizia.

onSuccessHook
Usato per eseguire i passaggi per eseguire azioni di rollback o pulizia.

onSuccessOrFailureHook
Usato per eseguire i passaggi per eseguire azioni di rollback o pulizia.

postRouteTrafficHook
Usato per eseguire i passaggi dopo che il traffico viene instradato. In genere, queste attività monitorano l'integrità della versione aggiornata per l'intervallo definito.

preDeployHook
Usato per eseguire i passaggi che inizializzano le risorse prima dell'avvio della distribuzione dell'applicazione.

routeTrafficHook
Usato per eseguire i passaggi che servono il traffico alla versione aggiornata.

Workspace
Opzioni dell'area di lavoro nell'agente.

Convenzioni di documentazione dello schema YAML

Il riferimento allo schema YAML è una guida dettagliata di riferimento alle pipeline YAML di Azure Pipelines. Include un catalogo di tutte le funzionalità YAML supportate e le opzioni disponibili.

Di seguito sono riportate le convenzioni di sintassi usate nel riferimento allo schema YAML.

• A sinistra di : è una parola chiave letterale usata nelle definizioni della pipeline.
• A destra di : è presente un tipo di dati. Il tipo di dati può essere un tipo primitivo come stringa o un riferimento a una struttura avanzata definita altrove in questo riferimento.
• Il tipo di dati di] notazione indica una matrice del tipo di definizione menzionato[. Ad esempio, [ string ] è una matrice di stringhe.
• Il tipo di dati tipo} di dati di : notazione { indica un mapping di un tipo di dati a un altro. Ad esempio, { string: string } è un mapping di stringhe a stringhe.
• Il simbolo | indica che sono disponibili più tipi di dati per la parola chiave. Ad esempio, job | template significa che è consentita una definizione di processo o un riferimento al modello.

Vedi anche

Questo riferimento illustra lo schema di un file YAML di Azure Pipelines. Per informazioni sulle nozioni di base di YAML, vedere Learn YAML in Y Minutes. Azure Pipelines non supporta tutte le funzionalità YAML. Le funzionalità non supportate includono ancoraggi, chiavi complesse e set. Inoltre, a differenza di YAML standard, Azure Pipelines dipende dalla visualizzazione stage, , jobtasko da un collegamento all'attività come script la prima chiave in un mapping.