AzurePowerShell@5 – Azure PowerShell v5 feladat

Ezzel a feladatsal PowerShell-szkriptet futtathat egy Azure-környezetben. Az Azure-környezet hitelesítése a megadott Azure Resource Manager szolgáltatáskapcsolattal történik.

Megjegyzés

Alapértelmezés szerint a Azure PowerShell v5 a PowerShell Core-t használja Linux-ügynökökhöz, és Windows PowerShell Windows-ügynökökhöz. Ha a PowerShell legújabb verzióját szeretné használni Windows-ügynökökön, állítsa a paramétert értékre pwshtrue. Ezután a PowerShell Core lesz használatban.

Syntax

# Azure PowerShell v5
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@5
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription. 
    #ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
    #ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path. 
    #Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script. 
    #ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments. 
    #errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
    #FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
  # Azure PowerShell version options
    #azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
    preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version. 
  # Advanced
    #pwsh: false # boolean. Use PowerShell Core. Default: false.
    #validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
    #workingDirectory: # string. Working Directory.

Bevitelek

azureSubscription - Azure-előfizetés
Bemeneti alias: ConnectedServiceNameARM. string. Kötelező.

Az Azure Resource Manager-előfizetést, amely konfigurálható a PowerShell futtatása előtt.

ScriptType - Szkript típusa
string. Engedélyezett értékek: FilePath (Szkriptfájl elérési útja), InlineScript (beágyazott szkript). Alapértelmezett érték: FilePath.

A szkript típusa: fájl elérési útja vagy beágyazott.

ScriptPath - Szkript elérési útja
string. Választható. Használja a következőt: ScriptType = FilePath.

A szkript elérési útja. Ennek egy teljes elérési útnak kell lennie, vagy az alapértelmezett munkakönyvtárhoz viszonyítva.

Inline - Beágyazott szkript
string. Választható. Használja a következőt: ScriptType = InlineScript. Alapértelmezett érték: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments.

A végrehajtandó szkriptet spekulálja. A beágyazott szkript maximális támogatott hossza 5000 karakter. Használjon egy fájlból származó szkriptet, ha hosszabb szkriptet szeretne használni.

ScriptArguments - Szkriptargumentumok
string. Választható. Használja a következőt: ScriptType = FilePath.

A PowerShellnek továbbadandó további paraméterek. Ezek lehetnek sorszám- vagy elnevezett paraméterek. Beágyazott szkriptek esetében nem alkalmazható.

errorActionPreference - ErrorActionPreference
string. Engedélyezett értékek: stop, continue, silentlyContinue. Alapértelmezett érték: stop.

Kiválasztja a változó értékét a ErrorActionPreference szkript végrehajtásához.

FailOnStandardError - Hiba a standard hiba miatt
boolean. Alapértelmezett érték: false.

Ha ez igaz, ez a feladat sikertelen lesz, ha bármilyen hiba a hibafolyamatba van írva, vagy ha bármilyen adat a standard hibastreambe van írva.

azurePowerShellVersion - Azure PowerShell verzió
Bemeneti alias: TargetAzurePs. string. Engedélyezett értékek: LatestVersion (Legújabb telepített verzió), OtherVersion (Más verzió megadása). Alapértelmezett érték: OtherVersion.

Üzemeltetett ügynökök esetén a támogatott Azure PowerShell verziók a következők1.0.0: , 1.6.0, 2.3.2, 2.6.0és 3.1.0 (üzemeltetett VS2017-üzenetsor). Az ügynökön elérhető legújabb verzió kiválasztásához válassza a (Legújabb telepített verzió) lehetőséget LatestVersion .

Magánügynökök esetén megadhatja a Azure PowerShell előnyben részesített verzióját a használatával OtherVersion (Más verzió megadása).

preferredAzurePowerShellVersion - Előnyben részesített Azure PowerShell verzió
Bemeneti alias: CustomTargetAzurePs. string. Akkor szükséges, ha TargetAzurePs = OtherVersion.

Az előnyben részesített Azure PowerShell verziónak megfelelő szemantikai verziónak kell lennie, például. 1.2.3. A Regex like 2.\*,2.3.\* nem támogatott. A üzemeltetett VS2017-készlet jelenleg az Az modulverziókat 1.0.0, 1.6.0, , 2.3.22.6.0és 3.1.0.

pwsh - A PowerShell Core használata
boolean. Alapértelmezett érték: false.

Ha ez igaz, akkor a Windows-ügynökökön futó feladatok az elérési útból lesznek használva pwsh.exe a helyett powershell.exe.

validateScriptSignature - Szkript aláírásának ellenőrzése
boolean. Választható. Használja a következőt: ScriptType = FilePath. Alapértelmezett érték: false.

Ha ez igaz, akkor a feladat először ellenőrzi, hogy a megadott szkript aláírása és érvényes-e a végrehajtása előtt.

workingDirectory - Munkakönyvtár
string.

A munkakönyvtár, ahol a szkript fut.

Feladatvezérlési lehetőségek

Minden feladathoz tartoznak vezérlési lehetőségek is a feladat bemenetei mellett. További információ: Vezérlési beállítások és gyakori feladattulajdonságok.

Kimeneti változók

Nincsenek.

Megjegyzések

Hibaelhárítás

A szkript helyileg működött, de nem sikerült a folyamatban

Ez általában akkor fordul elő, ha a folyamatban használt szolgáltatáskapcsolat nem rendelkezik megfelelő engedélyekkel a szkript futtatásához. A szkript helyileg az Ön hitelesítő adataival fut, és sikeres lesz, mivel lehet, hogy rendelkezik a szükséges hozzáféréssel.

A probléma megoldásához győződjön meg arról, hogy a szolgáltatásnév/hitelesítési hitelesítő adatok rendelkeznek a szükséges engedélyekkel. További információ: Az Azure-előfizetés erőforrásaihoz való hozzáférés kezelése a Role-Based Access Control használatával.

Hiba: Nem található a modul neve> verziószámmal:< "verzió>"<. Ha a modul nemrég lett telepítve, próbálkozzon újra az Azure Pipelines-feladatügynök újraindítása után

Azure PowerShell feladat az Azure/AzureRM/Az PowerShell-modul használatával kommunikál az Azure-előfizetéssel. Ez a probléma akkor fordul elő, ha a PowerShell-modul nem érhető el az üzemeltetett ügynökön. Ezért egy adott feladatverzió esetében az előnyben részesített Azure PowerShell verziót meg kell adni az elérhető verziók listájának Azure PowerShell verzióbeállításaiban. A telepített szoftver a Microsoft által üzemeltetett ügynökökSzoftver táblájában található.

Szolgáltatáskapcsolati problémák

A szolgáltatáskapcsolatokkal kapcsolatos problémák elhárításához lásd: Szolgáltatáskapcsolat hibaelhárítása.

Példák

Az alábbi példa bemutatja, hogyan hívhat meg egy parancsfájlt egy fájlból, és hogyan adhat át szkriptargumentumokat.

- task: AzurePowerShell@5
  inputs:
    azureSubscription: my-arm-service-connection
    scriptType: filePath
    scriptPath: $(Build.SourcesDirectory)\myscript.ps1
    scriptArguments:
      -Arg1 val1 `
      -Arg2 val2 `
      -Arg3 val3
    azurePowerShellVersion: latestVersion
    pwsh: true

Az alábbi argumentumok bemutatják, hogyan hívhat meg beágyazott szkripteket.

- task: AzurePowerShell@5
  inputs:
    azureSubscription: 'Azure subscription connection placeholder'
    azurePowerShellVersion: LatestVersion
    ScriptType: 'InlineScript'
    Inline: |
      # You can write your azure powershell scripts inline here. 
      # You can also pass predefined and custom variables to this script using arguments
      Write-Host 'Hello'
      Write-Host 'World!'

Követelmények

Követelmény	Leírás
Folyamattípusok	YAML, klasszikus build, klasszikus kiadás
Futtatás:	Ügynök, DeploymentGroup
Igények	None
Képességek	Ez a tevékenység nem felel meg a feladat későbbi tevékenységeire vonatkozó követelményeknek.
Parancskorlátozások	Bármelyik
Változók beállítása	Bármelyik
Ügynök verziója	2.115.0 vagy újabb
Feladatkategória	Üzembe helyezés