Változócsoportok hozzáadása > használata

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

A változócsoportok olyan értékeket és titkos kulcsokat tárolnak , amelyeket át szeretne adni egy YAML-folyamatnak , vagy több folyamaton keresztül elérhetővé kell tenni őket. Ugyanazon projektben több folyamat változócsoportjait is megoszthatja és használhatja.

A változócsoportok titkos változói védett erőforrások. Jóváhagyások, ellenőrzések és folyamatengedélyek kombinációjával korlátozhatja a titkos változókhoz való hozzáférést egy változócsoportban. A nem titkos változókhoz való hozzáférést a jóváhagyások, az ellenőrzések és a folyamatengedélyek nem korlátozzák.

Feljegyzés

A Microsoft Visual Studio Team Foundation Server 2018 és korábbi verziói az alábbi elnevezési különbségeket mutatják:

  • A buildelési és kiadási folyamatokat definícióknak nevezzük
  • A futtatásokat buildeknek nevezzük
  • A szolgáltatáskapcsolatokat szolgáltatásvégpontoknak nevezzük
  • A fázisokat környezeteknek nevezzük
  • A feladatokat fázisoknak nevezzük

Változócsoport létrehozása

A YAML-ben nem hozhat létre változócsoportokat, de a Változócsoport használata című cikkben leírtak szerint használhatók.

Változócsoport használata

Ha változócsoportból szeretne változót használni, adjon hozzá egy hivatkozást a csoporthoz a YAML-fájlban:

variables:
- group: my-variable-group

Ezután a változócsoport változói használhatók a YAML-fájlban.

Ha változókat és változócsoportokat is használ, használja az name/value egyes nem csoportosított változók szintaxisát:

variables:
- group: my-variable-group
- name: my-bare-variable
  value: 'value of my-bare-variable'

Változócsoportra való hivatkozáshoz használjon makrószintaxist vagy futtatókörnyezeti kifejezést. Az alábbi példában a csoportnak my-variable-group van egy változója.myhello

variables:
- group: my-variable-group
- name: my-passed-variable
  value: $[variables.myhello] # uses runtime expression

steps:
- script: echo $(myhello) # uses macro syntax
- script: echo $(my-passed-variable) 

Ugyanabban a folyamatban több változócsoportra is hivatkozhat. Ha több változócsoport is tartalmazza ugyanazt a változót, a YAML-fájlban utoljára szereplő változócsoport beállítja a változó értékét.

variables:
- group: my-first-variable-group
- group: my-second-variable-group

Sablon változócsoportra is hivatkozhat. A sablonban variables.ymla csoportra my-variable-group hivatkozunk. A változócsoport tartalmaz egy .myhello

# variables.yml
variables:
- group: my-variable-group

Ebben a folyamatban a $(myhello) változócsoport my-variable-group változója szerepel, és variables.yml hivatkozik gombra.

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

Változócsoport engedélyezése

Egy változócsoport használatához engedélyeznie kell a csoportot. Ha csak a YAML-ben nevezi el a változócsoportot, akkor bárki, aki le tudja küldeni a kódot az adattárba, kinyerheti a változócsoport titkos kulcsainak tartalmát. A csoport engedélyezéséhez használja az alábbi technikák egyikét:

  • Ha bármely folyamatot engedélyezni szeretne a változócsoport használatára, nyissa meg az Azure Pipelinest. Ez akkor lehet jó megoldás, ha nincsenek titkos kulcsok a csoportban. Válassza ki a Kódtár>változócsoportjait, majd válassza ki a kérdéses változócsoportot, és engedélyezze az Összes folyamathoz való hozzáférés engedélyezése beállítást.

  • Ha engedélyezni szeretne egy változócsoportot egy adott folyamathoz, nyissa meg a folyamatot, válassza a Szerkesztés lehetőséget, majd várjon manuálisan egy buildet. Megjelenik egy erőforrás-engedélyezési hiba és egy "Erőforrások engedélyezése" művelet a hibában. Ezt a műveletet választva explicit módon hozzáadhatja a folyamatot a változócsoport jogosult felhasználójaként.

Feljegyzés

Ha változócsoportot ad hozzá egy folyamathoz, és nem kap erőforrás-engedélyezési hibát a buildben, amikor várta, kapcsolja ki az Összes folyamathoz való hozzáférés engedélyezése beállítást.

A YAML-buildek nem érhetők el a TFS-en.

A csatolt változócsoportok változóértékeit ugyanúgy érheti el, mint a folyamaton belül definiált változókat. Ha például egy, a folyamathoz csatolt változócsoportban egy ügyfél nevű változó értékét szeretné elérni, használja $(customer) egy tevékenységparaméterben vagy egy szkriptben. A titkos változók (titkosított változók és kulcstartóváltozók) közvetlenül azonban nem érhetők el szkriptekben – ehelyett argumentumként kell átadni őket egy feladatnak. További információ: titkos kódok

A változócsoportokon végzett módosítások automatikusan elérhetők lesznek az összes definícióhoz vagy fázishoz, amelyhez a változócsoport kapcsolódik.

Változócsoportok listázása

A parancssori felülettel listázhatja a folyamatfuttatások változócsoportjait az az pipelines változócsoportlista paranccsal. Ha a CLI-hez készült Azure DevOps-bővítmény még nem érhető el, olvassa el az Azure DevOps parancssori felület használatának első lépéseit.

az pipelines variable-group list [--action {manage, none, use}]
                                 [--continuation-token]
                                 [--group-name]
                                 [--org]
                                 [--project]
                                 [--query-order {Asc, Desc}]
                                 [--top]

Választható paraméterek

  • művelet: Megadja a változócsoportokon végrehajtható műveletet. Az elfogadott értékek kezelése, nincs és használata.
  • folytatási jogkivonat: A folytatási jogkivonat megadása után listázza a változócsoportokat.
  • csoportnév: A változócsoport neve. A rendszer helyettesítő karaktereket fogad el, például new-var*.
  • org: Azure DevOps-szervezet URL-címe. Az alapértelmezett szervezet konfigurálása a következővel az devops configure -d organization=ORG_URL: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: . Példa: --org https://dev.azure.com/MyOrganizationName/
  • projekt: A projekt neve vagy azonosítója. Az alapértelmezett projekt konfigurálása a következővel az devops configure -d project=NAME_OR_ID: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: .
  • lekérdezési sorrend: Az eredményeket növekvő vagy csökkenő (alapértelmezett) sorrendben jeleníti meg. Az elfogadott értékek az Asc és a Desc.
  • felül: A listázandó változócsoportok száma.

Példa

Az alábbi parancs növekvő sorrendben sorolja fel az első három változócsoportot, és táblaformátumban adja vissza az eredményeket.

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

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

Változócsoport részleteinek megjelenítése

A projekt egy változócsoportjának részleteinek megjelenítése az az pipelines variable-group show paranccsal. Ha a CLI-hez készült Azure DevOps-bővítmény még nem érhető el, olvassa el az Azure DevOps parancssori felület használatának első lépéseit.

az pipelines variable-group show --group-id
                                 [--org]
                                 [--project]

Paraméterek

  • csoportazonosító: Kötelező. A változócsoport azonosítója. A változócsoport azonosítójának megkereséséhez lásd : Változócsoportok listázása.
  • org: Azure DevOps-szervezet URL-címe. Az alapértelmezett szervezet konfigurálása a következővel az devops configure -d organization=ORG_URL: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: . Példa: --org https://dev.azure.com/MyOrganizationName/
  • projekt: A projekt neve vagy azonosítója. Az alapértelmezett projekt konfigurálása a következővel az devops configure -d project=NAME_OR_ID: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: .

Példa

Az alábbi parancs a 4-es azonosítójú változócsoport részleteit mutatja be, és az eredményeket YAML formátumban adja vissza.

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

authorized: false
description: Variables for my new app
id: 4
name: MyNewAppVariables
providerData: null
type: Vsts
variables:
  app-location:
    isSecret: null
    value: Head_Office
  app-name:
    isSecret: null
    value: Fabrikam

Változócsoport törlése

Töröljön egy változócsoportot a projektben az az pipelines variable-group delete paranccsal. Ha a CLI-hez készült Azure DevOps-bővítmény még nem érhető el, olvassa el az Azure DevOps parancssori felület használatának első lépéseit.

az pipelines variable-group delete --group-id
                                   [--org]
                                   [--project]
                                   [--yes]

Paraméterek

  • csoportazonosító: Kötelező. A változócsoport azonosítója. A változócsoport azonosítójának megkereséséhez lásd : Változócsoportok listázása.
  • org: Azure DevOps-szervezet URL-címe. Az alapértelmezett szervezet konfigurálása a következővel az devops configure -d organization=ORG_URL: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: . Példa: --org https://dev.azure.com/MyOrganizationName/
  • projekt: A projekt neve vagy azonosítója. Az alapértelmezett projekt konfigurálása a következővel az devops configure -d project=NAME_OR_ID: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: .
  • Igen: Nem kötelező. Nem kér megerősítést.

Példa

Az alábbi parancs törli az 1- azonosítójú változócsoportot, és nem kér megerősítést.

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

Deleted variable group successfully.

Változók hozzáadása változócsoporthoz

Az Azure DevOps CLI-vel egy változót adhat hozzá egy változócsoporthoz egy folyamatban az az pipelines változócsoport-létrehozási paranccsal. Ha a CLI-hez készült Azure DevOps-bővítmény még nem érhető el, olvassa el az Azure DevOps parancssori felület használatának első lépéseit.

az pipelines variable-group variable create --group-id
                                            --name
                                            [--org]
                                            [--project]
                                            [--secret {false, true}]
                                            [--value]

Paraméterek

  • csoportazonosító: Kötelező. A változócsoport azonosítója. A változócsoport azonosítójának megkereséséhez lásd : Változócsoportok listázása.
  • név: Kötelező. A hozzáadni kívánt változó neve.
  • org: Azure DevOps-szervezet URL-címe. Az alapértelmezett szervezet konfigurálása a következővel az devops configure -d organization=ORG_URL: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: . Példa: --org https://dev.azure.com/MyOrganizationName/
  • projekt: A projekt neve vagy azonosítója. Az alapértelmezett projekt konfigurálása a következővel az devops configure -d project=NAME_OR_ID: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: .
  • titkos kód: Nem kötelező. Azt jelzi, hogy a változó értéke titkos-e. Az elfogadott értékek hamisak és igazak.
  • érték: Nem titkos változóhoz szükséges. A változó értéke. Titkos változók esetén, ha az értékparaméter nincs megadva, a rendszer a környezeti változó előtagjából AZURE_DEVOPS_EXT_PIPELINE_VAR_ választja ki, vagy a rendszer kéri a felhasználót, hogy szabványos bemenettel adja meg. Egy MySecret nevű változó például a környezeti változóval AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecretadható meg.

Példa

A következő parancs létrehoz egy változót a változócsoportban 4 azonosítóval. Az új változó neve bejelentkezést igényel, értéke Igaz, az eredmény pedig táblaformátumban jelenik meg.

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

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

Változók listázása egy változócsoportban

A változócsoportok változóit az az pipelines változócsoport változólista parancsával listázhatja. Ha a CLI-hez készült Azure DevOps-bővítmény még nem érhető el, olvassa el az Azure DevOps parancssori felület használatának első lépéseit.

az pipelines variable-group variable list --group-id
                                          [--org]
                                          [--project]

Paraméterek

  • csoportazonosító: Kötelező. A változócsoport azonosítója. A változócsoport azonosítójának megkereséséhez lásd : Változócsoportok listázása.
  • org: Azure DevOps-szervezet URL-címe. Az alapértelmezett szervezet konfigurálása a következővel az devops configure -d organization=ORG_URL: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: . Példa: --org https://dev.azure.com/MyOrganizationName/
  • projekt: A projekt neve vagy azonosítója. Az alapértelmezett projekt konfigurálása a következővel az devops configure -d project=NAME_OR_ID: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: .

Példa

Az alábbi parancs felsorolja a változócsoportban lévő összes változót 4 azonosítóval, és az eredményt táblaformátumban jeleníti meg.

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

Name            Is Secret    Value
--------------  -----------  -----------
app-location    False        Head_Office
app-name        False        Fabrikam
requires-login  False        True

Változócsoportok változóinak frissítése

Változócsoportban lévő változó frissítése az az pipelines változócsoport változófrissítési parancsával. Ha a CLI-hez készült Azure DevOps-bővítmény még nem érhető el, olvassa el az Azure DevOps parancssori felület használatának első lépéseit.

az pipelines variable-group variable update --group-id
                                            --name
                                            [--new-name]
                                            [--org]
                                            [--project]
                                            [--prompt-value {false, true}]
                                            [--secret {false, true}]
                                            [--value]

Paraméterek

  • csoportazonosító: Kötelező. A változócsoport azonosítója. A változócsoport azonosítójának megkereséséhez lásd : Változócsoportok listázása.
  • név: Kötelező. A hozzáadni kívánt változó neve.
  • új név: Nem kötelező. Adja meg a változó nevének módosításához.
  • org: Azure DevOps-szervezet URL-címe. Az alapértelmezett szervezet konfigurálása a következővel az devops configure -d organization=ORG_URL: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: . Példa: --org https://dev.azure.com/MyOrganizationName/
  • projekt: A projekt neve vagy azonosítója. Az alapértelmezett projekt konfigurálása a következővel az devops configure -d project=NAME_OR_ID: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: .
  • parancssori érték: Igaz értékrevan állítva egy titkos változó értékének frissítéséhez környezeti változó vagy kérés standard bemeneten keresztül. Az elfogadott értékek hamisak és igazak.
  • titkos kód: Nem kötelező. Azt jelzi, hogy a változó értéke titokban marad-e. Az elfogadott értékek hamisak és igazak.
  • érték: Frissítések a változó értékét. Titkos változók esetén a rendszer a parancssori érték paramétert használja a standard bemeneten keresztüli bevitel megadására. Nem interaktív konzolok esetén a környezeti változóval előtaggal AZURE_DEVOPS_EXT_PIPELINE_VAR_ellátott. Egy MySecret nevű változó például a környezeti változóval AZURE_DEVOPS_EXT_PIPELINE_VAR_MySecretadható meg.

Példa

Az alábbi parancs frissíti a kötelező bejelentkezési változót az új False értékkel a változócsoportban 4 azonosítójú értékkel. Megadja, hogy a változó titkos kód, és az eredményt YAML formátumban jeleníti meg. Figyelje meg, hogy a kimenet hamis helyett null értékként jeleníti meg az értéket, mivel titkos rejtett érték.

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

requires-login:
  isSecret: true
  value: null

Változók törlése változócsoportból

Változó törlése egy változócsoportból az az pipelines változócsoport változó törlési parancsával. Ha a CLI-hez készült Azure DevOps-bővítmény még nem érhető el, olvassa el az Azure DevOps parancssori felület használatának első lépéseit.

az pipelines variable-group variable delete --group-id
                                            --name
                                            [--org]
                                            [--project]
                                            [--yes]

Paraméterek

  • csoportazonosító: Kötelező. A változócsoport azonosítója. A változócsoport azonosítójának megkereséséhez lásd : Változócsoportok listázása.
  • név: Kötelező. A törölni kívánt változó neve.
  • org: Azure DevOps-szervezet URL-címe. Az alapértelmezett szervezet konfigurálása a következővel az devops configure -d organization=ORG_URL: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: . Példa: --org https://dev.azure.com/MyOrganizationName/
  • projekt: A projekt neve vagy azonosítója. Az alapértelmezett projekt konfigurálása a következővel az devops configure -d project=NAME_OR_ID: . Kötelező, ha nincs alapértelmezettként konfigurálva, vagy ha a rendszer felvette a következőt git config: .
  • Igen: Nem kötelező. Nem kér megerősítést.

Példa

Az alábbi parancs törli a kötelező bejelentkezési változót a 4 azonosítójú változócsoportból, és megerősítést kér.

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

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

Feljegyzés

Az Azure szerepköralapú hozzáférés-vezérlést (Azure RBAC) használó Key Vaultok nem támogatottak.

Meglévő Azure Key Vault csatolása egy változócsoporthoz, és a szelektív tároló titkos kulcsainak leképezése a változócsoporthoz.

  1. A Változócsoportok lapon engedélyezze az Azure Key Vault titkos kulcsainak csatolását változóként. Szüksége lesz egy meglévő kulcstartóra, amely tartalmazza a titkos kulcsokat. Hozzon létre egy kulcstartót az Azure Portal használatával.

    Screenshot of variable group with Azure key vault integration.

  2. Adja meg az Azure-előfizetés végpontját és a titkos kulcsokat tartalmazó tároló nevét.

    Győződjön meg arról, hogy az Azure-szolgáltatáskapcsolat rendelkezik legalább get and list management engedélyekkel a tárolón a titkos kódokhoz. Engedélyezze az Azure Pipelines számára ezeknek az engedélyeknek a beállítását a tároló neve melletti Engedélyezés lehetőség választásával. Vagy állítsa be manuálisan az engedélyeket az Azure Portalon:

    1. Nyissa meg a tárolóhoz tartozó Gépház, majd válassza az Új hozzáadása hozzáférési szabályzatot>.
    2. Válassza az Egyszerű kiválasztása lehetőséget, majd válassza ki az ügyfélfiókhoz tartozó szolgáltatásnevet.
    3. Válassza a Titkos kódok engedélyeket , és győződjön meg arról, hogy a Beolvasás és a Lista jelölőnégyzetekkel rendelkezik.
    4. A módosítások mentéséhez kattintson az OK gombra .
  3. A Változócsoportok lapon válassza a + Hozzáadás lehetőséget a tároló adott titkos kulcsainak kiválasztásához a változócsoporthoz való leképezéshez.

Kulcstartó titkos kulcsának kezelése

Tekintse meg a titkos kódok kezelésére vonatkozó hasznos tippek alábbi listáját.

  • Csak a titkos nevek lesznek leképezve a változócsoportra, nem a titkos értékekre. A tárolóból lekért legújabb titkos kódérték a változócsoporthoz csatolt folyamatfuttatásban használatos.

  • A kulcstartóban meglévő titkos kulcsok módosításai automatikusan elérhetők lesznek a változócsoport által használt összes folyamat számára.

  • Amikor új titkos kulcsokat adnak hozzá vagy törölnek a tárolóból, a társított változócsoportok nem frissülnek automatikusan. A változócsoport titkos kulcsait explicit módon frissíteni kell, hogy a változócsoportot használó folyamatok megfelelően legyenek végrehajtva.

  • Az Azure Key Vault támogatja a titkosítási kulcsok és titkos kódok tárolását és kezelését az Azure-ban. Az Azure Pipelines változócsoport-integrációja jelenleg csak az Azure Key Vault titkos kulcsainak leképezését támogatja. A titkosítási kulcsok és tanúsítványok nem támogatottak.

Változók kibontása egy csoportban

Amikor beállít egy változót egy csoportban, és yaML-fájlban használja, az megegyezik a YAML-fájl más definiált változóival. A változók elsőbbségéről további információt a Változók című témakörben talál.

A YAML nem támogatott a TFS-ben.