AzureResourceGroupDeployment@2 – Úloha nasazení skupiny prostředků Azure v2

Nasazení šablony Azure Resource Manager (ARM) do skupiny prostředků a správa virtuálních počítačů

Syntax

# Azure resource group deployment v2
# Deploy an Azure Resource Manager (ARM) template to a resource group and manage virtual machines.
- task: AzureResourceGroupDeployment@2
  inputs:
  # Azure Details
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'Select Resource Group' | 'Start' | 'Stop' | 'StopWithDeallocate' | 'Restart' | 'Delete' | 'DeleteRG'. Required. Action. Default: Create Or Update Resource Group.
    resourceGroupName: # string. Required. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group. Deployment mode. Default: Incremental.
  # Advanced deployment options for virtual machines
    #enableDeploymentPrerequisites: 'None' # 'None' | 'ConfigureVMwithWinRM' | 'ConfigureVMWithDGAgent'. Optional. Use when action = Create Or Update Resource Group || action = Select Resource Group. Enable prerequisites. Default: None.
    #teamServicesConnection: # string. Alias: deploymentGroupEndpoint. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Azure Pipelines service connection. 
    #teamProject: # string. Alias: project. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Team project. 
    #deploymentGroupName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. Password. 
    #outputVariable: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Group. VM details for WinRM. 
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

Vstupy

azureSubscription - Předplatné Azure
Alias vstupu: ConnectedServiceName. string. Povinná hodnota.

Vybere připojení služby, které obsahuje předplatné Azure pro nasazení.

action - Akce
string. Povinná hodnota. Povolené hodnoty: Create Or Update Resource Group, Select Resource Group (Možnosti konfigurace nasazení virtuálních počítačů), Start (Spustit virtuální počítače), Stop (Zastavit virtuální počítače), StopWithDeallocate (Zastavit a zrušit přidělení virtuálních počítačů), Restart (Restartovat virtuální počítače), Delete (Odstranit virtuální počítače) DeleteRG (Odstranit skupinu prostředků). Výchozí hodnota: Create Or Update Resource Group.

Akce, která se má provést s prostředky nebo skupinou prostředků Azure.

resourceGroupName - Skupina prostředků
string. Povinná hodnota.

Poskytuje název skupiny prostředků.

location - Umístění
string. Vyžaduje se, když action = Create Or Update Resource Group.

Umístění pro nasazení skupiny prostředků. Pokud skupina prostředků už v předplatném existuje, bude se tato hodnota ignorovat.

templateLocation - Umístění šablony
string. Vyžaduje se, když action = Create Or Update Resource Group. Povolené hodnoty: Linked artifact, URL of the file. Výchozí hodnota: Linked artifact.

Vyberte odkazovaný artefakt nebo adresu URL souboru.

csmFileLink - Odkaz na šablonu
string. Vyžaduje se, když templateLocation = URL of the file && action = Create Or Update Resource Group.

Určuje adresu URL souboru šablony. Příklad adresy URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Pokud chcete nasadit šablonu uloženou v účtu privátního úložiště, načtěte token sdíleného přístupového podpisu (SAS) a zahrňte ho do adresy URL šablony. Příklad: <blob_storage_url>/template.json?<SAStoken>

Pokud chcete nahrát soubor šablony (nebo propojenou šablonu) do účtu úložiště a vygenerovat token SAS, použijte úlohu Kopírování souborů Azure nebo postupujte podle pokynů pomocí PowerShellu nebo Azure CLI.

Pokud chcete zobrazit parametry šablony v mřížce, klikněte na ... vedle textového pole přepsání parametrů šablony. Tato funkce vyžaduje, aby na zdroji byla povolená pravidla CORS. Pokud jsou šablony v objektu blob úložiště Azure, projděte si téma Vysvětlení požadavků CORS pro povolení CORS.

csmParametersFileLink - Odkaz na parametry šablony
string. Nepovinný parametr. Použijte, když templateLocation = URL of the file && action = Create Or Update Resource Group.

Určuje adresu URL souboru parametrů. Příklad: https://raw.githubusercontent.com/Azure/...

Pokud chcete použít soubor uložený v účtu privátního úložiště, načtěte token sdíleného přístupového podpisu (SAS) a zahrňte ho do adresy URL šablony. Příklad: <blob_storage_url>/template.json?<SAStoken> Pokud chcete nahrát soubor parametrů do účtu úložiště a vygenerovat token SAS, můžete použít úlohu kopírování souborů Azure nebo postupovat podle pokynů pomocí PowerShellu nebo Azure CLI.

Pokud chcete zobrazit parametry šablony v mřížce, klikněte na ... vedle textového pole přepsání parametrů šablony. Tato funkce vyžaduje, aby na zdroji byla povolená pravidla CORS. Pokud jsou šablony v objektu blob úložiště Azure, projděte si téma Vysvětlení požadavků CORS pro povolení CORS.

csmFile - Šablony
string. Vyžaduje se, když templateLocation = Linked artifact && action = Create Or Update Resource Group.

Určuje cestu nebo vzor odkazující na šablonu Azure Resource Manager. Přečtěte si další informace o šablonách Azure Resource Manager. Pokud chcete začít okamžitě, použijte tuto ukázkovou šablonu.

csmParametersFile - Parametry šablony
string. Nepovinný parametr. Použijte, když templateLocation = Linked artifact && action = Create Or Update Resource Group.

Určuje adresu URL souboru parametrů. Příklad adresy URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Pokud chcete použít soubor uložený v účtu privátního úložiště, načtěte token sdíleného přístupového podpisu (SAS) a zahrňte ho do adresy URL šablony. Příklad: <blob_storage_url>/template.json?<SAStoken> Pokud chcete nahrát soubor parametrů do účtu úložiště a vygenerovat token SAS, použijte úlohu kopírování souborů Azure nebo postupujte podle kroků pomocí PowerShellu nebo Azure CLI.

Pokud chcete zobrazit parametry šablony v mřížce, klikněte na ... vedle textového pole přepsání parametrů šablony. Tato funkce vyžaduje, aby na zdroji byla povolená pravidla CORS. Pokud jsou šablony v objektu blob úložiště Azure, projděte si téma Vysvětlení požadavků CORS pro povolení CORS.

overrideParameters - Přepsání parametrů šablony
string. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group.

Určuje parametry šablony, které se mají přepsat.

Pokud chcete zobrazit parametry šablony v mřížce, klikněte na ... vedle textového pole přepsání parametrů. Tato funkce vyžaduje, aby na zdroji byla povolená pravidla CORS. Pokud jsou šablony v objektu blob úložiště Azure, odkazujte na tento řetězec a povolte CORS nebo do textového pole zadejte parametry šablony, které se mají přepsat.

Příklad: -storageName fabrikam -adminUsername $(vmusername) -adminPassword (ConvertTo-SecureString -String '$(password)' -AsPlainText -Force) -azureKeyVaultName $(fabrikamFibre).

Pokud má hodnota parametru více slov, uzavřete je do uvozovek, i když hodnotu předáváte pomocí proměnných. Například, -name "parameter value" -name2 "$(var)". Pokud chcete přepsat parametry typu objektu, použijte řetězcové objekty JSON. Například, -options ["option1"] -map {"key1": "value1" }.

deploymentMode - Režim nasazení
string. Vyžaduje se, když action = Create Or Update Resource Group. Povolené hodnoty: Incremental, CompleteValidation (Pouze ověřování). Výchozí hodnota: Incremental.

Režim Incremental zpracovává nasazení jako přírůstkové aktualizace skupiny prostředků. Ponechá nezměněné prostředky, které existují ve skupině prostředků, ale nezadají se v šabloně.

Complete Režim odstraní prostředky, které nejsou v šabloně. Úplný režim trvá relativně déle než přírůstkový režim. Pokud časový limit úkolu vyprší, zvažte zvýšení časového limitu nebo změnu do Incremental režimu.

Upozornění

Režim úplného dokončení odstraní všechny existující prostředky ve skupině prostředků, které nejsou v šabloně zadané. Zkontrolujte, jestli skupina prostředků, do které nasazujete, neobsahuje žádné nezbytné prostředky, které nejsou v šabloně uvedené.

Validate Režim umožňuje najít problémy se šablonou před vytvořením skutečných prostředků.

Poznámka

Režim Validate vždy vytvoří skupinu prostředků, i když nejsou nasazené žádné prostředky.

Přečtěte si další informace o režimech nasazení.

enableDeploymentPrerequisites - Povolení požadavků
string. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group || action = Select Resource Group. Povolené hodnoty: None, ConfigureVMwithWinRM (Konfigurace pomocí agenta WinRM) ConfigureVMWithDGAgent (Konfigurace pomocí agenta skupiny nasazení). Výchozí hodnota: None.

Platí jenom v případě, že skupina prostředků obsahuje virtuální počítače.

Výběrem možnosti Skupina nasazení nakonfigurujete agenta skupiny nasazení na každém virtuálním počítači.

Výběrem možnosti WinRM nakonfigurujete naslouchací proces Vzdálené správy systému Windows (WinRM) přes protokol HTTPS na portu 5986 pomocí certifikátu podepsaného svým držitelem. Tato konfigurace se vyžaduje k provádění operace nasazení na počítačích Azure. Pokud jsou cílové virtuální počítače zálohované nástrojem pro vyrovnávání zatížení, ujistěte se, že jsou pravidla příchozího překladu adres nakonfigurovaná pro cílový port (5986).

teamServicesConnection - Připojení služby Azure Pipelines
Alias vstupu: deploymentGroupEndpoint. string. Vyžaduje se, když enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group.

Určuje připojení služby pro připojení k organizaci nebo kolekci Azure DevOps za účelem registrace agenta.

Připojení služby můžete vytvořit pomocí +New příkazu a pak vybrat Token-based authentication. K nastavení připojení služby potřebujete token PAT . Kliknutím Manage aktualizujte podrobnosti o připojení služby.

teamProject - Týmový projekt
Alias vstupu: project. string. Vyžaduje se, když enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group.

Určuje týmový projekt, který definuje skupinu nasazení.

deploymentGroupName - Skupina nasazení
string. Vyžaduje se, když enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group.

Určuje skupinu nasazení, do které se agenti zaregistrují. Přečtěte si další informace o skupinách nasazení.

copyAzureVMTags - Kopírování značek virtuálních počítačů Azure do agentů
boolean. Nepovinný parametr. Použijte, když enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Výchozí hodnota: true.

Zvolí, jestli je potřeba zkopírovat nakonfigurované značky na virtuálním počítači Azure do odpovídajícího agenta skupiny nasazení.

Ve výchozím nastavení se všechny značky Azure kopírují ve formátu . Key: Value Příklad: Značka Role : Web Azure se do počítače agenta zkopíruje tak, jak je.

Přečtěte si další informace o používání značek pro prostředky Azure.

runAgentServiceAsUser - Spuštění služby agenta jako uživatel
boolean. Nepovinný parametr. Použijte, když enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Výchozí hodnota: false.

Spustí službu agenta jako jiný uživatel než výchozí uživatel, pokud je hodnota nastavená na true.

Výchozí uživatel je NT AUTHORITY\\SYSTEM ve Windows a root v Linuxu.

userName - Uživatelské jméno
string. Vyžaduje se, když enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group.

Uživatelské jméno pro spuštění služby agenta na virtuálních počítačích.

Pro uživatele domény zadejte hodnoty jako domain\username nebo username@domain.com. Pro místní uživatele zadejte username.

Předpokládá se, že se na všech virtuálních počítačích ve skupině prostředků nachází stejný uživatel domény nebo místní uživatel se stejným názvem.

password - Heslo
string. Nepovinný parametr. Použijte, když enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group.

Heslo pro uživatele ke spuštění služby agenta na virtuálních počítačích s Windows.

Předpokládá se, že heslo je stejné pro zadaného uživatele na všech virtuálních počítačích.

Může přijímat proměnné definované v kanálech buildu nebo verze jako $(passwordVariable). Proměnnou můžete označit tak, že secret ji zabezpečíte.

U virtuálních počítačů s Linuxem se heslo nevyžaduje a bude se ignorovat.

outputVariable - Podrobnosti o virtuálních počítačích pro WinRM
string. Nepovinný parametr. Použijte, když enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Group.

Vyžaduje se, pokud je vybraná existující skupina prostředků. Poskytuje název proměnné skupiny prostředků. Proměnnou je možné použít jako $(variableName) odkaz na skupinu prostředků v následných úlohách, jako je například úloha PowerShellu na cílových počítačích pro nasazení aplikací.

Platí pouze v případě, že vybraná akce je Create, Updatenebo Select.

deploymentName - Název nasazení
string. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group.

Určuje název nasazení skupiny prostředků, které se má vytvořit.

deploymentOutputs - Výstupy nasazení
string. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group.

Poskytuje název výstupní proměnné, která obsahuje oddíl outputs aktuálního objektu nasazení ve formátu řetězce. Pomocí rutiny PowerShellu ConvertFrom-Json parsujte objekt JSON a získejte přístup k jednotlivým výstupním hodnotám.

addSpnToEnvironment - Přístup k podrobnostem o instančním objektu v parametrech přepsání
boolean. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group. Výchozí hodnota: false.

Přidá ID instančního objektu a klíč koncového bodu Azure zvoleného jako spouštěcí prostředí skriptu. Proměnné $servicePrincipalId a $servicePrincipalKey mohou být v parametrech přepsání, například -key $servicePrincipalKey.

useWithoutJSON - Použijte jednotlivé výstupní hodnoty bez JSON. Použití stringify
boolean. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group. Výchozí hodnota: false.

Jednotlivé výstupní hodnoty se převádějí prostřednictvím formátu JSON. Ve výchozím nastavení stringify. Pokud chcete výstupní hodnoty použít tak, jak jsou, aniž byste je převáděli přes JSON. Stringify, povolte tuto možnost. Další podrobnosti najdete v tomto článku.

Možnosti ovládání úloh

Všechny úlohy mají kromě vstupů také možnosti ovládání. Další informace najdete v tématu Možnosti ovládacích prvků a běžné vlastnosti úlohy.

Výstupní proměnné

Žádné

Poznámky

K dispozici je nová verze této úlohy na AzureResourceManagerTemplateDeployment@3 – úloha nasazení šablony ARM verze 3.

Novinky v úloze verze 2

• Funguje s agenty pro různé platformy (Linux, macOS nebo Windows)
• Podporuje šablony JSON umístěné na všech veřejně přístupných adresách URL http/https.
• Vylepšené uživatelské prostředí pro parametry přepsání, které se teď dají zobrazit nebo upravit v mřížce.
• Mapování pravidel NAT pro virtuální počítače, které jsou zálohované nástrojem pro vyrovnávání zatížení.
• Pole Skupina prostředků se teď přejmenuje na Podrobnosti o virtuálním počítači pro WinRM a je zahrnuto v části Upřesnit možnosti nasazení pro virtuální počítače.
• Omezení:
  • Žádná podpora klasických předplatných. Podporují se jenom předplatná ARM.
  • Syntaxe PowerShellu není podporována, protože úloha je teď node.js založena. Při přepsání parametrů šablony zajistěte, aby se rozlišovala malá a velká písmena v názvech parametrů. Při migraci z verze 1.0 na verzi 2.0 také odeberte rutiny PowerShellu, jako je ConvertTo-SecureString.

Poradce při potížích

Chyba: Vnitřní chyba serveru

Tyto problémy jsou většinou přechodné povahy. Může k tomu docházet z několika důvodů:

• Jedna ze služeb Azure, které se pokoušíte nasadit, prochází údržbou v oblasti, do které se pokoušíte nasadit. https://status.azure.com/ Sledujte výpadky služeb Azure.
• Samotná služba Azure Pipelines prochází údržbou. https://status.dev.azure.com/ Sledujte výpadky.

V některých případech jsme se však setkali s tím, že to bylo způsobeno chybou v šabloně ARM, například služba Azure, kterou se snažíte nasadit, nepodporuje oblast, kterou jste pro daný prostředek vybrali.

Chyba: Vypršení časového limitu

Problémy s vypršením časového limitu můžou pocházet ze dvou míst:

• Agent služby Azure Pipelines
• Nasazení portálu

Pokud chcete zjistit, jestli k vypršení časového limitu dochází na portálu, zkontrolujte odkaz pro nasazení portálu, který bude v protokolech úloh. Pokud tam žádný odkaz není, je příčinou pravděpodobně agent služby Azure Pipelines. Pokud odkaz najdete, přejděte na tento odkaz a zjistěte, jestli nedošlo k vypršení časového limitu v nasazení portálu.

Chyba: Pravidla CORS, která se mají povolit při přepisování parametrů

Pokud se při přepisování parametrů v kanálu odkazuje na soubor šablony z objektu BLOB, může se vám zobrazit následující zpráva s upozorněním:

Warning: Failed to download the file from template path.

Tato funkce vyžaduje, aby byla ve zdroji povolená pravidla CORS. Pokud jsou šablony v objektu blob služby Azure Storage, podívejte se na téma Podpora sdílení prostředků mezi zdroji a povolte CORS.

Kromě povolení CORS se ujistěte, že token SAS zadaný v odkazu šablony je srt-sco. Tento token je vyžadován k tomu, abyste mohli soubor stáhnout a pokračovat.

Agent služby Azure Pipelines

Pokud problém pochází z agenta Azure Pipelines, můžete časový limit zvýšit nastavením časového limitu timeoutInMinutes jako klíče v JAZYCE YAML na hodnotu 0. Další informace viz Zadání úloh v kanálu.

Nasazení portálu

Podívejte se na tuto dokumentaci, jak zjistit, jestli chyba pochází z Azure Portal: Zobrazení historie nasazení pomocí Azure Resource Manager.

V případě nasazení portálu zkuste v šabloně ARM nastavit timeoutInMinutes na hodnotu 0. Pokud není hodnota zadána, předpokládá se hodnota 60 minut. 0 zajišťuje, aby nasazení běžela tak dlouho, jak je to možné, aby bylo úspěšné.

K tomu může dojít také kvůli přechodným problémům v systému. https://status.dev.azure.com/ Sledujte, jestli ve službě Azure Pipelines nedochází k výpadku.

Chyba: U šablony Azure Resource Manager (ARM) se nezdařilo ověření.

K tomuto problému dochází většinou kvůli neplatnému parametru v šabloně ARM, například kvůli nepodporované položce SKU nebo oblasti. Pokud se ověření nezdaří, zkontrolujte chybovou zprávu. Měla by vás odkázat na prostředek a parametr, který je neplatný.

K tomuto problému může také docházet kvůli víceřádkovým řetězcům. Úloha nasazení skupiny prostředků Azure v současné době nepodporuje víceřádkové řetězce v šabloně ARM nebo v souboru JSON s parametry.

Kromě toho si přečtěte tento článek týkající se struktury a syntaxe šablon ARM: Vysvětlení struktury a syntaxe šablon ARM.

Požadavky

Požadavek	Popis
Typy kanálů	YAML, klasický build, klasická verze
Běží na	Agent, DeploymentGroup
Požadavky	Žádné
Možnosti	Tento úkol nesplňuje žádné požadavky na následné úkoly v úloze.
Omezení příkazů	Všechny
Nastavitelné proměnné	Všechny
Verze agenta	2.119.1 nebo vyšší
Kategorie úloh	Nasazení