AzureCLI@1 — zadanie interfejsu wiersza polecenia platformy Azure w wersji 1

Artykuł
07/02/2024

Uruchom polecenia interfejsu wiersza polecenia platformy Azure względem subskrypcji platformy Azure w skrypcie powłoki podczas uruchamiania w agencie systemu Linux lub skryptu wsadowego podczas uruchamiania w agencie systemu Windows.

Uruchom skrypt powłoki lub wsadowy za pomocą poleceń interfejsu wiersza polecenia platformy Azure w ramach subskrypcji platformy Azure.

Składnia

# Azure CLI v1
# Run Azure CLI commands against an Azure subscription in a Shell script when running on Linux agent or Batch script when running on Windows agent.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #addSpnToEnvironment: false # boolean. Access service principal details in script. Default: false.
    #useGlobalConfig: false # boolean. Use global Azure CLI configuration. Default: false.
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Azure CLI v1
# Run a Shell or Batch script with Azure CLI commands against an azure subscription.
- task: AzureCLI@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: args. Arguments. 
  # Advanced
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Dane wejściowe

azureSubscription - Subskrypcja platformy Azure
Alias wejściowy: connectedServiceNameARM. string. Wymagane.

Wybiera subskrypcję usługi Azure Resource Manager dla wdrożenia.

scriptLocation - Lokalizacja skryptu
string. Wymagane. Dozwolone wartości: inlineScript (skrypt wbudowany), scriptPath (ścieżka skryptu). Wartość domyślna: scriptPath.

Wybiera lokalizację skryptu.

scriptPath - Ścieżka skryptu
string. Wymagane, gdy scriptLocation = scriptPath.

W pełni kwalifikowana ścieżka skryptu lub ścieżki względem domyślnego katalogu roboczego.

inlineScript - Wbudowany skrypt
string. Wymagane, gdy scriptLocation = inlineScript.

Skrypty można napisać tutaj. W przypadku korzystania z agenta systemu Windows użyj skryptów wsadowych. Używanie skryptów powłoki podczas korzystania z agentów opartych na systemie Linux. W przypadku plików wsadowych użyj prefiksu call przed każdym poleceniem platformy Azure. Możesz również przekazać wstępnie zdefiniowane i niestandardowe zmienne do tego skryptu przy użyciu argumentów

Poniżej przedstawiono przykłady. Pierwszy to przykład powłoki, a drugi to przykład wsadowy:

azure --version || azure account show

call  azure --version || call azure account show

arguments - Argumenty
Alias wejściowy: args. string.

Argumenty przekazane do skryptu.

addSpnToEnvironment - Uzyskiwanie dostępu do szczegółów jednostki usługi w skryscie
boolean. Wartość domyślna: false.

Dodaje identyfikator jednostki usługi i klucz punktu końcowego platformy Azure wybranego do środowiska wykonywania skryptu. Zmienne i $servicePrincipalKey można użyć $servicePrincipalId w skrycie.

Jest to honorowane tylko wtedy, gdy punkt końcowy platformy Azure ma schemat uwierzytelniania jednostki usługi.

useGlobalConfig - Korzystanie z globalnej konfiguracji interfejsu wiersza polecenia platformy Azure
boolean. Wartość domyślna: false.

Jeśli jest to fałsz, to zadanie będzie używać własnego oddzielnego katalogu konfiguracji interfejsu wiersza polecenia platformy Azure. Może to służyć do uruchamiania zadań interfejsu wiersza polecenia platformy Azure w równoległych wersjach.

workingDirectory - Katalog roboczy
Alias wejściowy: cwd. string.

Bieżący katalog roboczy, w którym jest uruchamiany skrypt. Jeśli te dane wejściowe są puste, jest to katalog główny repozytorium (kompilacja) lub artefakty (wydanie), czyli $(System.DefaultWorkingDirectory).

failOnStandardError - Błąd standardowy kończy się niepowodzeniem
boolean. Wartość domyślna: false.

Jeśli te dane wejściowe są prawdziwe, to zadanie zakończy się niepowodzeniem, gdy wszelkie błędy są zapisywane w strumieniu StandardError. Wyczyść pole wyboru, aby zignorować standardowe błędy i zamiast tego polegać na kodach zakończenia w celu określenia stanu.

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

Co nowego w wersji 1.0:

Obsługuje nowy interfejs wiersza polecenia platformy Azure 2.0 oparty na języku Python
Współpracuje z agentami międzyplatformowymi (Linux, macOS lub Windows)
Aby pracować z interfejsem wiersza polecenia platformy Azure 1.0 (opartym na node.js), przejdź do zadania w wersji 0.0
Ograniczenia: — brak obsługi klasycznych subskrypcji platformy Azure. Interfejs wiersza polecenia platformy Azure w wersji 2.0 obsługuje tylko subskrypcje usługi Azure Resource Manager (ARM).

Wymagania

Wymaganie	Opis
Typy potoków	YAML, kompilacja klasyczna, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Brak
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	2.0.0 lub nowsze
Kategoria zadania	Wdrażanie

Udostępnij za pośrednictwem