AzurePowerShell@3 — zadanie Azure PowerShell w wersji 3
To zadanie służy do uruchamiania skryptu programu PowerShell w środowisku platformy Azure. Kontekst platformy Azure jest uwierzytelniany przy użyciu podanego połączenia usługi Azure Resource Manager.
Składnia
# Azure PowerShell v3
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@3
inputs:
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. 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
#validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
# Azure PowerShell v3
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@3
inputs:
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. 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.
Dane wejściowe
azureConnectionType
- Typ połączenia platformy Azure
Alias wejściowy: ConnectedServiceNameSelector
. string
. Dozwolone wartości: ConnectedServiceName
(wersja klasyczna platformy Azure), ConnectedServiceNameARM
(Azure Resource Manager). Wartość domyślna: ConnectedServiceNameARM
.
azureClassicSubscription
- Klasyczna subskrypcja platformy Azure
Alias wejściowy: ConnectedServiceName
. string
. Wymagane, gdy ConnectedServiceNameSelector = ConnectedServiceName
.
Subskrypcja klasyczna platformy Azure do skonfigurowania przed uruchomieniem programu PowerShell.
azureSubscription
- Subskrypcja platformy Azure
Alias wejściowy: ConnectedServiceNameARM
. string
. Wymagane, gdy ConnectedServiceNameSelector = ConnectedServiceNameARM
.
Subskrypcja usługi Azure Resource Manager do skonfigurowania przed uruchomieniem programu PowerShell.
ScriptType
- Typ skryptu
string
. Dozwolone wartości: FilePath
(Ścieżka pliku skryptu), InlineScript
(wbudowany skrypt). Wartość domyślna: FilePath
.
Typ skryptu: ścieżka pliku lub wbudowany.
ScriptPath
- Ścieżka skryptu
string
. Opcjonalny. Użyj polecenia , gdy ScriptType = FilePath
.
Ścieżka skryptu. Powinna to być w pełni kwalifikowana ścieżka lub ścieżka względna względem domyślnego katalogu roboczego.
Inline
- Skrypt wbudowany
string
. Opcjonalny. Użyj polecenia , gdy ScriptType = InlineScript
. Wartość domyślna: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments
.
Określa skrypt do wykonania. Maksymalna obsługiwana długość skryptu wbudowanego to 5000 znaków. Użyj skryptu z pliku, jeśli chcesz użyć dłuższego skryptu.
ScriptArguments
- Argumenty skryptu
string
. Opcjonalny. Użyj polecenia , gdy ScriptType = FilePath
.
Dodatkowe parametry do przekazania do programu PowerShell. Mogą to być parametry porządkowe lub nazwane.
errorActionPreference
- ErrorActionPreference
string
. Dozwolone wartości: stop
, continue
, silentlyContinue
. Wartość domyślna: stop
.
Wybiera wartość zmiennej ErrorActionPreference
do wykonywania skryptu.
FailOnStandardError
- Błąd standardowy kończy się niepowodzeniem
boolean
. Wartość domyślna: false
.
Jeśli to prawda, to zadanie zakończy się niepowodzeniem, jeśli jakiekolwiek błędy zostaną zapisane w potoku błędów lub jeśli jakiekolwiek dane zostaną zapisane w standardowym strumieniu błędów.
azurePowerShellVersion
- wersja Azure PowerShell
Alias wejściowy: TargetAzurePs
. string
. Dozwolone wartości: LatestVersion
(najnowsza zainstalowana wersja) OtherVersion
(Określ inną wersję). Wartość domyślna: OtherVersion
.
W przypadku hostowanych agentów obsługiwane wersje Azure PowerShell to 2.1.0
, 3.8.0
, 4.2.1
5.1.1
i 6.7.0
.
Aby wybrać najnowszą wersję dostępną dla agenta, wybierz pozycję LatestVersion
(Najnowsza zainstalowana wersja).
W przypadku agentów prywatnych można określić preferowaną wersję Azure PowerShell przy użyciu opcji OtherVersion
(Określ inną wersję).
preferredAzurePowerShellVersion
- Preferowana wersja Azure PowerShell
Alias wejściowy: CustomTargetAzurePs
. string
. Wymagane, gdy TargetAzurePs = OtherVersion
.
Preferowana wersja Azure PowerShell musi być właściwą wersją semantyczną, np. 1.2.3.
. Wyrażenie regularne, takie jak 2.\*,2.3.\*
, nie jest obsługiwane. Hostowani agenci obecnie obsługują wersje modułów 2.1.0
platformy Azure, 3.8.0
, 4.2.1
, 5.1.1
i Moduł AzureRM , 4.2.1
3.8.0
, , 5.1.1
6.7.0
.2.1.0
validateScriptSignature
- Weryfikowanie podpisu skryptu
boolean
. Opcjonalny. Użyj polecenia , gdy ScriptType = FilePath
. Wartość domyślna: false
.
Jeśli jest to prawda, zadanie najpierw sprawdzi, czy określony skrypt jest podpisany i prawidłowy przed jego wykonaniem.
Opcje sterowania zadania
Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.
Zmienne wyjściowe
Brak.
Uwagi
Dodano obsługę niepowodzenia w przypadku błędu standardowego i errorActionPreference.
Wymagania
Wymaganie | Opis |
---|---|
Typy potoków | YAML, klasyczna kompilacja, wersja klasyczna |
Działa w | Agent, DeploymentGroup |
Wymagania | Agenci hostowani samodzielnie muszą mieć możliwości zgodne z następującymi wymaganiami dotyczącymi uruchamiania zadań korzystających z tego zadania: azureps |
Możliwości | To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu. |
Ograniczenia poleceń | Dowolne |
Zmienne ustawialne | Dowolne |
Wersja agenta | 2.0.0 lub nowsza |
Kategoria zadania | Wdrażanie |