Hantera variabelgrupper

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Den här artikeln beskriver hur du skapar och använder variabelgrupper i Azure Pipelines. Variabelgrupper lagrar värden och hemligheter som du kan skicka till en YAML-pipeline eller göra tillgängliga över flera pipelines i ett projekt.

Hemliga variabler i variabelgrupper är skyddade resurser. Du kan lägga till kombinationer av godkännanden, kontroller och pipelinebehörigheter för att begränsa åtkomsten till hemliga variabler i en variabelgrupp. Åtkomst till icke-säkerhetsvariabler begränsas inte av godkännanden, kontroller eller pipelinebehörigheter.

Variabelgrupper följer bibliotekssäkerhetsmodellen för roller och behörigheter.

Förutsättningar

• En Azure DevOps Services-organisation och ett projekt där du har behörighet att skapa pipelines och variabler.
• Ett projekt i din Azure DevOps-organisation eller Azure DevOps Server-samling. Skapa ett projekt om du inte har något.
• Om du använder Azure DevOps CLI behöver du Azure CLI version 2.30.0 eller senare med Azure DevOps CLI-tillägget. Mer information finns i Kom igång med Azure DevOps CLI.

Konfigurera CLI

Om du använder Azure DevOps CLI måste du konfigurera CLI för att arbeta med din Azure DevOps-organisation och ditt projekt.

1. Logga in på din Azure DevOps-organisation med hjälp av kommandot az login .

   az login
   

2. Om du uppmanas till det väljer du din prenumeration i listan som visas i terminalfönstret.

3. Se till att du kör den senaste versionen av Azure CLI och Azure DevOps-tillägget med hjälp av följande kommandon.

   az upgrade
   az extension add --name azure-devops --upgrade
   

4. I Azure DevOps CLI-kommandon kan du ange standardorganisationen och projektet med hjälp av:

   az devops configure --defaults organization=<YourOrganizationURL> project=<Project Name or ID>`
   

   Om du inte har angett standardorganisationen och projektet kan du använda parametern detect=true i dina kommandon för att automatiskt identifiera organisationen och projektkontexten baserat på din aktuella katalog. Om standardvärdena inte har konfigurerats eller identifierats måste du uttryckligen ange parametrarna org och project i dina kommandon.

Skapa en variabelgrupp

Du kan skapa variabelgrupper för pipelinekörningarna i projektet.

Kommentar

Om du vill skapa en hemlig variabelgrupp för att länka hemligheter från ett Azure-nyckelvalv som variabler följer du anvisningarna i Länka en variabelgrupp till hemligheter i Azure Key Vault.

Användargränssnitt för Azure Pipelines

1. I ditt Azure DevOps-projekt väljer du Pipelines-bibliotek> på den vänstra menyn.

2. På sidan Bibliotek väljer du gruppen + Variabel.

   

3. På den nya variabelgruppens sida under Egenskaper anger du ett namn och en valfri beskrivning för variabelgruppen.

4. Under Variabler väljer du + Lägg till och anger sedan ett variabelnamn och värde som ska inkluderas i gruppen. Om du vill kryptera och lagra värdet på ett säkert sätt väljer du låsikonen bredvid variabeln.

5. Välj + Lägg till för att lägga till varje ny variabel. När du har lagt till variabler väljer du Spara.

   

Nu kan du använda den här variabelgruppen i projektpipelines.

Azure DevOps CLI

I Azure DevOps Services kan du skapa variabelgrupper med hjälp av Azure DevOps CLI.

Om du vill skapa en variabelgrupp använder du kommandot az pipelines variable-group create .

Följande kommando skapar till exempel en variabelgrupp med namnet home-office-config, lägger till variablerna app-location=home-office och app-name=contoso, och utdata resulterar i YAML-format.

az pipelines variable-group create --name home-office-config
                                   --variables app-location=home-office app-name=contoso
                                   --output yaml

Utdata:

authorized: false
description: null
id: 5
name: home-office-config
providerData: null
type: Vsts
variables:
  app-location:
    isSecret: null
    value: home-office
  app-name:
    isSecret: null
    value: contoso

Uppdatera variabelgrupper

Användargränssnitt för Azure Pipelines

Du kan uppdatera variabelgrupper med hjälp av användargränssnittet för Azure Pipelines.

1. I ditt Azure DevOps-projekt väljer du Pipelines-bibliotek> på den vänstra menyn.
2. På sidan Bibliotek väljer du den variabelgrupp som du vill uppdatera. Du kan också hovra över listan med variabelgrupper, välja ikonen Fler alternativ och välja Redigera på menyn.
3. På sidan variabelgrupp ändrar du någon av egenskaperna och väljer sedan Spara.

Azure DevOps CLI

I Azure DevOps Services kan du uppdatera variabelgrupper med hjälp av Azure DevOps CLI.

Lista variabelgrupper

Om du vill uppdatera en variabelgrupp eller variablerna i den med hjälp av Azure DevOps CLI använder du variabelgruppen group-id.

Du kan hämta värdet för variabelgruppens ID från utdata från kommandot för att skapa variabelgrupper eller använda kommandot az pipelines variable-group list .

Följande kommando visar till exempel de tre första projektvariabelgrupperna i stigande ordning och returnerar resultatet, inklusive variabelgrupps-ID, i tabellformat.

az pipelines variable-group list --top 3 --query-order Asc --output table

Utdata:

ID    Name               Type    Number of Variables
----  -----------------  ------  ---------------------
1     myvariables        Vsts    2
2     newvariables       Vsts    4
3     new-app-variables  Vsts    3

Uppdatera en variabelgrupp

Om du vill uppdatera en variabelgrupp använder du kommandot az pipelines variable-group update .

Kommentar

Du kan inte uppdatera en variabelgrupp av typen AzureKeyVault med hjälp av Azure DevOps CLI.

Följande kommando uppdaterar till exempel variabelgruppen med ID 4 för att ändra name resultatet och description, och utdata i tabellformat.

az pipelines variable-group update --group-id 4
                                   --name my-new-variables
                                   --description "New home office variables"
                                   --output table

Utdata:

ID    Name              Description               Is Authorized  Number of Variables
----  ----------------  ------------------------- -------------  -------------------
4     my-new-variables  New home office variables false          2

Visa information för en variabelgrupp

Du kan använda kommandot az pipelines variable-group show för att visa information om en variabelgrupp. Följande kommando visar till exempel information för variabelgruppen med ID 4 och returnerar resultatet i YAML-format.

az pipelines variable-group show --group-id 4 --output yaml

Utdata:

authorized: false
description: Variables for my new app
id: 4
name: my-new-variables
providerData: null
type: Vsts
variables:
  app-location:
    isSecret: null
    value: home-office
  app-name:
    isSecret: null
    value: contoso

Ta bort en variabelgrupp

Användargränssnitt för Azure Pipelines

Du kan ta bort variabelgrupper i användargränssnittet för Azure Pipelines.

1. I ditt Azure DevOps-projekt väljer du Pipelines-bibliotek> på den vänstra menyn.
2. Hovra över den variabelgrupp som du vill ta bort på sidan Bibliotek och välj ikonen Fler alternativ.
3. Välj Ta bort på menyn och välj sedan Ta bort på bekräftelseskärmen.

Azure DevOps CLI

I Azure DevOps Services kan du ta bort variabelgrupper med hjälp av Azure DevOps CLI.

Om du vill ta bort en variabelgrupp använder du kommandot az pipelines variable-group delete . Följande kommando tar till exempel bort variabelgruppen med ID 1 och ber inte om bekräftelse.

az pipelines variable-group delete --group-id 1 --yes

Hantera variabler i variabelgrupper

Användargränssnitt för Azure Pipelines

Du kan ändra, lägga till eller ta bort variabler i variabelgrupper med hjälp av användargränssnittet för Azure Pipelines.

1. I ditt Azure DevOps-projekt väljer du Pipelines-bibliotek> på den vänstra menyn.
2. På sidan Bibliotek väljer du den variabelgrupp som du vill uppdatera. Du kan också hovra över listan med variabelgrupper, välja ikonen Fler alternativ och välja Redigera på menyn.
3. På sidan variabelgrupp kan du:
   • Ändra något av variabelnamnen eller värdena.
   • Ta bort någon av variablerna genom att välja papperskorgsikonen bredvid variabelnamnet.
   • Ändra variabler till hemlighet eller icke-sekret genom att välja låsikonen bredvid variabelvärdet.
   • Lägg till nya variabler genom att välja + Lägg till.
4. När du har gjort ändringar väljer du Spara.

Azure DevOps CLI

I Azure DevOps Services kan du hantera variabler i variabelgrupper med hjälp av Azure DevOps CLI.

Lista variabler i en variabelgrupp

Om du vill visa variablerna i en variabelgrupp använder du kommandot az pipelines variable-group variable list . Följande kommando visar till exempel alla variabler i variabelgruppen med ID 4 och visar resultatet i tabellformat.

az pipelines variable-group variable list --group-id 4 --output table

Utdata:

Name            Is Secret    Value
--------------  -----------  -----------
app-location    False        home-office
app-name        False        contoso

Lägga till variabler i en variabelgrupp

Om du vill lägga till en variabel i en variabelgrupp använder du kommandot az pipelines variable-group variable create .

Följande kommando skapar till exempel en ny variabel med namnet requires-login med standardvärdet true i variabelgruppen med ID 4. Resultatet visas i tabellformat.

az pipelines variable-group variable create --group-id 4
                                            --name requires-login
                                            --value true
                                            --output table

Utdata:

Name            Is Secret    Value
--------------  -----------  -------
requires-login  False        true

Uppdatera variabler i en variabelgrupp

Om du vill uppdatera variabler i en variabelgrupp använder du kommandot az pipelines variable-group variable update .

Kommentar

Du kan inte uppdatera variabler i en variabelgrupp av typen AzureKeyVault med hjälp av Azure DevOps CLI. Du kan uppdatera variabler via kommandona az keyvault .

Följande kommando uppdaterar till exempel variabeln requires-login med det nya värdet false i variabelgruppen med ID 4och visar resultatet i YAML-format. Kommandot anger att variabeln är en secret.

az pipelines variable-group variable update --group-id 4
                                            --name requires-login
                                            --value false
                                            --secret true
                                            --output yaml

Utdata visar värdet som null i stället för false eftersom det är ett hemligt dolt värde.

requires-login:
  isSecret: true
  value: null

Hantera hemliga variabler

Om du vill hantera hemliga variabler använder du kommandot az pipelines variable-group variable update med följande parametrar:

• secret: Ange till för true att ange att variabelns värde hålls hemligt.
• prompt-value: Ange till för att true uppdatera värdet för en hemlig variabel med hjälp av en miljövariabel eller fråga via standardindata.
• value: För hemliga variabler använder du parametern prompt-value för att uppmanas att ange värdet via standardindata. För icke-interaktiva konsoler kan du hämta miljövariabeln med AZURE_DEVOPS_EXT_PIPELINE_VAR_prefixet . Du kan till exempel ange en variabel med namnet MySecret med hjälp av miljövariabeln AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecret.

Ta bort variabler från en variabelgrupp

Om du vill ta bort en variabel från en variabelgrupp använder du kommandot az pipelines variable-group variable delete . Följande kommando tar till exempel bort variabeln requires-login från variabelgruppen med ID 4.

az pipelines variable-group variable delete --group-id 4 --name requires-login

Kommandot frågar efter bekräftelse eftersom det är standardinställningen. Använd parametern --yes för att hoppa över bekräftelseprompten.

Are you sure you want to delete this variable? (y/n): y
Deleted variable 'requires-login' successfully.

Använda variabelgrupper i pipelines

Du kan använda variabelgrupper i YAML- eller klassiska pipelines. Ändringar som du gör i en variabelgrupp är automatiskt tillgängliga för alla definitioner eller faser som variabelgruppen är länkad till.

YAML

Om du bara namnger variabelgruppen i YAML-pipelines kan alla som kan skicka kod till lagringsplatsen extrahera innehållet i hemligheterna i variabelgruppen. Om du vill använda en variabelgrupp med YAML-pipelines måste du därför auktorisera pipelinen att använda gruppen. Du kan auktorisera en pipeline för att använda en variabelgrupp i användargränssnittet för Azure Pipelines eller med hjälp av Azure DevOps CLI.

Auktorisering via pipelines-användargränssnittet

Du kan auktorisera pipelines för att använda dina variabelgrupper med hjälp av användargränssnittet för Azure Pipelines.

1. I ditt Azure DevOps-projekt väljer du Pipelines-bibliotek> på den vänstra menyn.
2. På sidan Bibliotek väljer du den variabelgrupp som du vill auktorisera.
3. På sidan variabelgrupp väljer du fliken Pipelinebehörigheter .
4. På skärmen Pipelinebehörigheter väljer du + och väljer sedan en pipeline som ska auktoriseras. Eller välj ikonen Fler åtgärder , välj Öppna åtkomst och välj Öppna åtkomst igen för att bekräfta.

Om du väljer en pipeline godkänns pipelinen att använda variabelgruppen. Om du vill auktorisera en annan pipeline väljer du + ikonen igen. Om du väljer Öppna åtkomst kan alla projektpipelines använda variabelgruppen. Öppen åtkomst kan vara ett bra alternativ om du inte har några hemligheter i gruppen.

Ett annat sätt att auktorisera en variabelgrupp är att välja pipelinen, välja Redigera och sedan köa en version manuellt. Du ser ett resursauktoriseringsfel och kan sedan uttryckligen lägga till pipelinen som en behörig användare av variabelgruppen.

Auktorisering via Azure DevOps CLI

I Azure DevOps Services kan du auktorisera variabelgrupper med hjälp av Azure DevOps CLI.

Om du vill auktorisera alla projektpipelines att använda variabelgruppen anger du parametern authorize i kommandot az pipelines variable-group create till true. Den här öppna åtkomsten kan vara ett bra alternativ om du inte har några hemligheter i gruppen.

Länka en variabelgrupp till en pipeline

När du har auktorisera en YAML-pipeline för att använda en variabelgrupp kan du använda variabler i gruppen i pipelinen.

Om du vill använda variabler från en variabelgrupp lägger du till en referens till gruppnamnet i YAML-pipelinefilen.

variables:
- group: my-variable-group

Du kan referera till flera variabelgrupper i samma pipeline. Om flera variabelgrupper innehåller variablerna med samma namn anger den sista variabelgruppen som använder variabeln i filen variabelns värde. Mer information om variablers prioritet finns i Expansion av variabler.

Du kan också referera till en variabelgrupp i en mall. Följande variables.yml mallfil refererar till variabelgruppen my-variable-group. Variabelgruppen innehåller en variabel med namnet myhello.

variables:
- group: my-variable-group

YAML-pipelinen refererar till mallen variables.yml och använder variabeln $(myhello) från variabelgruppen my-variable-group.

stages:
- stage: MyStage
  variables:
  - template: variables.yml
  jobs:
  - job: Test
    steps:
    - script: echo $(myhello)

Använda variabler i en länkad variabelgrupp

Du kommer åt variabelvärdena i en länkad variabelgrupp på samma sätt som du kommer åt variabler som du definierar i pipelinen. Om du till exempel vill komma åt värdet för en variabel med namnet customer i en variabelgrupp som är länkad till pipelinen kan du använda $(customer) i en aktivitetsparameter eller ett skript.

Om du använder både fristående variabler och variabelgrupper i pipelinefilen använder du syntaxen name-value för de fristående variablerna.

variables:
- group: my-variable-group
- name: my-standalone-variable
  value: 'my-standalone-variable-value'

Om du vill referera till en variabel i en variabelgrupp kan du använda makrosyntax eller ett körningsuttryck. I följande exempel har gruppen my-variable-group en variabel med namnet myhello.

Så här använder du ett körningsuttryck:

variables:
- group: my-variable-group
- name: my-passed-variable
  value: $[variables.myhello]
- script: echo $(my-passed-variable)

Så här använder du makrosyntax:

variables:
- group: my-variable-group

steps:
- script: echo $(myhello)

Du kan inte komma åt hemliga variabler, inklusive krypterade variabler och nyckelvalvsvariabler, direkt i skript. Du måste skicka dessa variabler som argument till en uppgift. Mer information finns i Hemliga variabler.

Klassisk

Använda variabelgrupper i klassiska pipelines

Klassiska pipelines kan använda variabelgrupper utan separat auktorisering. Så här använder du en variabelgrupp:

1. Öppna den klassiska pipelinen.

2. Välj Variabler>Variabelgrupper och välj sedan Länka variabelgrupp.

   • I en byggpipeline visas en lista över tillgängliga grupper. Välj en variabelgrupp och välj Länka. Alla variabler i gruppen är tillgängliga för användning i pipelinen.

   • I en versionspipeline visas även en listruta med steg i pipelinen. Länka variabelgruppen till själva pipelinen eller till ett eller flera specifika steg i versionspipelinen. Om du länkar till en eller flera steg begränsas variablerna från variabelgruppen till dessa faser och är inte tillgängliga i de andra stegen i versionen.

   

När du anger en variabel med samma namn i flera omfång används följande prioritet, högst först:

1. Variabel som anges vid kötid
2. Variabeluppsättning i pipelinen
3. Variabeluppsättning i variabelgruppen

Mer information om variablers prioritet finns i Expansion av variabler.

Kommentar

Variabler i olika grupper som är länkade till en pipeline i samma omfång (till exempel jobb eller fas) kolliderar och resultatet kan vara oförutsägbart. Se till att du använder olika namn för variabler i alla dina variabelgrupper.

Relaterade artiklar

• Definiera variabler
• Definiera anpassade variabler
• Använda hemliga och icke-sekretiska variabler i variabelgrupper
• Använd Azure Key Vault-hemligheter i Azure Pipelines
• Lägga till godkännanden och kontroller