Használati változócsoportok hozzáadása &
Azure DevOps Services | Azure DevOps Server 2020 | 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 elérhetővé szeretne tenni több folyamaton keresztül. A változócsoportokat több folyamatban is megoszthatja és használhatja ugyanabban a projektben.
A változócsoportok védett erőforrások. Jóváhagyásokat és ellenőrzéseket adhat ezekhez a változókhoz, és beállíthatja a folyamatengedélyeket.
Megjegyzés
A Microsoft Team Foundation Server (TFS) 2018 és korábbi verzióiban a buildelési és kiadási folyamatokat definícióknak, a futtatásokatbuildeknek, a szolgáltatáskapcsolatokatszolgáltatásvégpontoknak, a fázisokatkörnyezeteknek, a feladatokatpedig fázisoknak nevezzük.
Változócsoport létrehozása
A YAML-ben nem hozhat létre változócsoportokat, de használhatók a Változócsoport használata című szakaszban leírtak szerint.
Változócsoport használata
Ha változócsoportból szeretne változót használni, adjon hozzá egy hivatkozást a csoportra 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 állítja be a változó értékét.
variables:
- group: my-first-variable-group
- group: my-second-variable-group
A sablonban lévő változócsoportokra is hivatkozhat. A sablon variables.ymla csoportra my-variable-group hivatkozik. 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 a függvény 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
A változócsoport használatához engedélyeznie kell a csoportot. Ha csak a YAML-ben adja a változócsoportnak a nevet, 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 módszerek egyikét:
Ha engedélyezni szeretné bármelyik folyamat számára a változócsoport használatát, lépjen az Azure Pipelinesba. Ez akkor lehet jó megoldás, ha nem rendelkezik titkos kódokkal a csoportban. Válassza aKönyvtárváltozó-csoportok> lehetőséget, majd válassza ki a kérdéses változócsoportot, és engedélyezze a Hozzáférés engedélyezése az összes folyamathoz 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. A hibában egy erőforrás-engedélyezési hiba és egy "Erőforrások engedélyezése" művelet jelenik meg. Ezt a műveletet választva explicit módon hozzáadhatja a folyamatot a változócsoport jogosult felhasználójaként.
Megjegyzés
Ha változócsoportot ad hozzá egy folyamathoz, és nem kap erőforrás-engedélyezési hibát a buildben, amikor azt 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 ügyfél nevű változó értékét szeretné elérni a folyamathoz csatolt változócsoportban, használjon $(customer) tevékenységparamétert vagy szkriptet. A titkos változók (titkosított változók és Key Vault-változók) azonban nem érhetők el közvetlenül a 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ület használatával listázhatja a folyamatfuttatások változócsoportjait az az pipelines változócsoport-lista paranccsal. Ha a CLI-hez készült Azure DevOps-bővítmény új Önnek, tekintse meg az Azure DevOps PARANCSSORI 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: Meghatározza a változócsoportokon végrehajtható műveletet. Az elfogadott értékek a kezelés, a nincs és a használat.
- folytatási jogkivonat: A folytatási jogkivonat megadása után megjeleníti a változócsoportokat.
- csoport neve: A változócsoport neve. A rendszer helyettesítő karaktereket fogad el, például
new-var*. - org: Azure DevOps-szervezet URL-címe. Konfigurálja az alapértelmezett szervezetet a következővel
az devops configure -d organization=ORG_URL: . Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. Példa:--org https://dev.azure.com/MyOrganizationName/. - projekt: A projekt neve vagy azonosítója. Konfigurálja az alapértelmezett projektet a használatával
az devops configure -d project=NAME_OR_ID. Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. - lekérdezéssorrend: Az eredményeket növekvő vagy csökkenő (alapértelmezett) sorrendben jeleníti meg. Az elfogadott értékek az Asc és a Desc.
- top: A listázandó változócsoportok száma.
Példa
A következő parancs növekvő sorrendben listázza az első három változócsoportot, és táblázatos formá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 projektben lévő változócsoport 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 új Önnek, tekintse meg az Azure DevOps PARANCSSORI 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ó megkereséséhez lásd a Változócsoportok listázása című témakört.
- org: Azure DevOps-szervezet URL-címe. Konfigurálja az alapértelmezett szervezetet a következővel
az devops configure -d organization=ORG_URL: . Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. Példa:--org https://dev.azure.com/MyOrganizationName/. - projekt: A projekt neve vagy azonosítója. Konfigurálja az alapértelmezett projektet a használatával
az devops configure -d project=NAME_OR_ID. Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át.
Példa
Az alábbi parancs a 4-es azonosítójú változócsoport részleteit mutatja be, és YAML formátumban adja vissza az eredményeket.
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 új Önnek, tekintse meg az Azure DevOps PARANCSSORI 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ó megkereséséhez lásd a Változócsoportok listázása című témakört.
- org: Azure DevOps-szervezet URL-címe. Konfigurálja az alapértelmezett szervezetet a következővel
az devops configure -d organization=ORG_URL: . Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. Példa:--org https://dev.azure.com/MyOrganizationName/. - projekt: A projekt neve vagy azonosítója. Konfigurálja az alapértelmezett projektet a használatával
az devops configure -d project=NAME_OR_ID. Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. - 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 parancsával. Ha a CLI-hez készült Azure DevOps-bővítmény új Önnek, tekintse meg az Azure DevOps PARANCSSORI 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ó megkereséséhez lásd a Változócsoportok listázása című témakört.
- name: Kötelező megadni. A hozzáadni kívánt változó neve.
- org: Azure DevOps-szervezet URL-címe. Konfigurálja az alapértelmezett szervezetet a következővel
az devops configure -d organization=ORG_URL: . Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. Példa:--org https://dev.azure.com/MyOrganizationName/. - projekt: A projekt neve vagy azonosítója. Konfigurálja az alapértelmezett projektet a használatával
az devops configure -d project=NAME_OR_ID. Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. - 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 nincs megadva értékparaméter , akkor a rendszer kiválasztja azt a környezeti változóból, amely előtaggal
AZURE_DEVOPS_EXT_PIPELINE_VAR_van ellátva, vagy a rendszer a felhasználótól kéri, hogy adja meg a standard bemeneten keresztül. Egy MySecret nevű változó például a környezeti változóvalAZURE_DEVOPS_EXT_PIPELINE_VAR_MySecretadható meg.
Példa
Az alábbi parancs egy 4 azonosítójú változót hoz létre a változócsoportban. Az új változó neve bejelentkezést igényel , értéke Igaz, az eredmény pedig táblázatos formá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 új Önnek, tekintse meg az Azure DevOps PARANCSSORI 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ó megkereséséhez lásd a Változócsoportok listázása című témakört.
- org: Azure DevOps-szervezet URL-címe. Konfigurálja az alapértelmezett szervezetet a következővel
az devops configure -d organization=ORG_URL: . Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. Példa:--org https://dev.azure.com/MyOrganizationName/. - projekt: A projekt neve vagy azonosítója. Konfigurálja az alapértelmezett projektet a használatával
az devops configure -d project=NAME_OR_ID. Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át.
Példa
Az alábbi parancs a 4 azonosítójú változócsoportban lévő összes változót listázza, és az eredményt táblázatos formá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 új Önnek, tekintse meg az Azure DevOps PARANCSSORI 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ó megkereséséhez lásd a Változócsoportok listázása című témakört.
- name: Kötelező megadni. A hozzáadni kívánt változó neve.
- új-név: Nem kötelező. Itt módosíthatja a változó nevét.
- org: Azure DevOps-szervezet URL-címe. Konfigurálja az alapértelmezett szervezetet a következővel
az devops configure -d organization=ORG_URL: . Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. Példa:--org https://dev.azure.com/MyOrganizationName/. - projekt: A projekt neve vagy azonosítója. Konfigurálja az alapértelmezett projektet a használatával
az devops configure -d project=NAME_OR_ID. Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. - prompt-value: True ( igaz ) értékre van állítva egy titkos változó értékének környezeti változóval vagy standard bemeneten keresztüli parancssor használatával történő frissítéséhez. 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íti a változó értékét. Titkos változók esetén használja a prompt-value paramétert, amelyet a rendszer a standard bemeneten keresztül történő bevitelre kér. Nem interaktív konzolok esetén a környezeti változókból lehet kiválogatni a következő előtaggal
AZURE_DEVOPS_EXT_PIPELINE_VAR_: . Egy MySecret nevű változó például a környezeti változóvalAZURE_DEVOPS_EXT_PIPELINE_VAR_MySecretadható meg.
Példa
Az alábbi parancs frissíti a kötelező bejelentkezési változót a False (Hamis ) új értékkel a 4 azonosítójú változócsoportban. Megadja, hogy a változó egy 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 ez egy 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 egy változócsoportból
Változó törlése egy változócsoportból az az pipelines variable-group variable delete paranccsal. Ha a CLI-hez készült Azure DevOps-bővítmény új Önnek, tekintse meg az Azure DevOps PARANCSSORI 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ó megkereséséhez lásd a Változócsoportok listázása című témakört.
- name: Kötelező megadni. A törölni kívánt változó neve.
- org: Azure DevOps-szervezet URL-címe. Konfigurálja az alapértelmezett szervezetet a következővel
az devops configure -d organization=ORG_URL: . Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. Példa:--org https://dev.azure.com/MyOrganizationName/. - projekt: A projekt neve vagy azonosítója. Konfigurálja az alapértelmezett projektet a használatával
az devops configure -d project=NAME_OR_ID. Kötelező, ha nem alapértelmezettként van konfigurálva, vagy a rendszer a használatávalgit configveszi át. - igen: Nem kötelező. Nem kér megerősítést.
Példa
A következő parancs törli a kötelező bejelentkezési változót a 4azonosí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.
Titkos kódok csatolása Azure Key Vaultból
Meglévő Azure Key Vault társítása egy változócsoporthoz, és a szelektív tároló titkos kulcsainak leképezése a változócsoporthoz.
A Változócsoportok lapon engedélyezze a titkos kulcsok csatolását egy Azure-kulcstartóból változóként. Szüksége lesz egy meglévő kulcstartóra, amely tartalmazza a titkos kódokat. Hozzon létre egy kulcstartót az Azure Portal használatával.
Adja meg az Azure-előfizetés végpontját és a titkos kódokat tartalmazó tároló nevét.
Győződjön meg arról, hogy az Azure-szolgáltatáskapcsolat legalább Get és List felügyeleti engedélyekkel rendelkezik a tárolóban a titkos kódokhoz. Engedélyezze, hogy az Azure Pipelines beállítsa ezeket az engedélyeket a tároló neve melletti Engedélyezés lehetőség kiválasztásával. Vagy állítsa be manuálisan az engedélyeket az Azure Portalon:
- Nyissa meg a tároló beállításait , majd válassza az Új hozzáadása hozzáférési szabályzatok>lehetőséget.
- Válassza a Rendszerbiztonsági tag kiválasztása lehetőséget, majd válassza ki az ügyfélfiók szolgáltatásnevét.
- Válassza a Titkos kulcs engedélyeket , és győződjön meg arról, hogy a Beolvasás és a Lista jelölőnégyzetekkel rendelkezik.
- Kattintson az OK gombra a módosítások mentéséhez.
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.
Key Vault titkos kulcsok kezelése
A titkos kódok kezelésével kapcsolatos hasznos tippeket az alábbi listában találja.
Csak a titkos kódok nevei lesznek leképezve a változócsoportra, a titkos kódok értékeire nem. 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.
Csoport változóinak kibontása
Amikor beállít egy változót egy csoportban, és egy 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.