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

Nasaďte šablonu Azure Resource Manageru (ARM) do skupiny prostředků a spravujte virtuální počítače.

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 (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Azure Pipelines service connection. 
    #teamProject: # string. Alias: project. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Team project. 
    #deploymentGroupName: # string. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true. Password. 
    #outputVariable: # string. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && (enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None). 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ého Azure
Vstupní alias: ConnectedServiceName. string. Požadovaný.

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

action - akce
string. Požadovaný. Povolené hodnoty: Create Or Update Resource Group, Select Resource Group (konfigurace možností nasazení virtuálního počítače), Start (spuštění virtuálních počítačů), Stop (zastavení virtuálních počítačů), StopWithDeallocate (zastavení a zrušení přidělení virtuálních počítačů), Restart (restartování virtuálních počítačů), Delete (odstranění virtuálních počítačů), DeleteRG (odstranění skupiny prostředků). Výchozí hodnota: Create Or Update Resource Group.

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

skupiny prostředků resourceGroupName -
string. Požadovaný.

Poskytuje název skupiny prostředků.

umístění location -
string. Požadováno při action = Create Or Update Resource Group.

Umístění pro nasazení skupiny prostředků. Pokud skupina prostředků již v předplatném existuje, bude tato hodnota ignorována.

templateLocation - umístění šablony
string. Požadováno při 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.

odkaz šablony csmFileLink -
string. Požadováno při 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 vlož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 kroků pomocí PowerShellu nebo Azure CLI.

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

propojení parametrů šablony csmParametersFileLink -
string. Volitelný. Používá se při 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 privátním účtu úložiště, načtěte token sdíleného přístupového podpisu (SAS) a vložte ho do adresy URL šablony. Příklad: <blob_storage_url>/template.json?<SAStoken> K nahrání souboru parametrů do účtu úložiště a vygenerování tokenu SAS můžete použít úlohu kopírování souborů Azure nebo postupovat podle kroků pomocí PowerShellu nebo Azure CLI.

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

šablony csmFile -
string. Požadováno při templateLocation = Linked artifact && action = Create Or Update Resource Group.

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

csmParametersFile - parametry šablony
string. Volitelný. Používá se při 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 privátním účtu úložiště, načtěte token sdíleného přístupového podpisu (SAS) a vložte ho do adresy URL šablony. Příklad: <blob_storage_url>/template.json?<SAStoken> K nahrání souboru parametrů do účtu úložiště a vygenerování tokenu 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řepsat parametry šablony. Tato funkce vyžaduje, aby byla ve zdroji povolená pravidla CORS. Pokud jsou šablony v objektu blob úložiště Azure, přečtěte si Vysvětlení požadavků CORS povolení CORS.

overrideParameters - Přepsání parametrů šablony
string. Volitelný. Používá se při 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řepsat parametry. Tato funkce vyžaduje, aby byla ve zdroji povolená pravidla CORS. Pokud jsou šablony v objektu blob úložiště Azure, použijte tento řetězec, abyste povolili CORS, nebo zadejte parametry šablony, které se mají přepsat do textového pole.

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ž předáte hodnotu pomocí proměnných. Například -name "parameter value" -name2 "$(var)". Pokud chcete přepsat parametry typu objektu, použijte objekty JSON s řetězci. Například -options ["option1"] -map {"key1": "value1" }.

režimu nasazení deploymentMode -
string. Požadováno při action = Create Or Update Resource Group. Povolené hodnoty: Incremental, Complete, Validation (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 nejsou zadané v šabloně.

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

Varování

Úplný režim odstraní všechny existující prostředky ve skupině prostředků, které nejsou zadané v šabloně. Zkontrolujte, jestli skupina prostředků, do které nasazujete, neobsahuje žádné potřebné prostředky, které nejsou zadané v šabloně.

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 nasazeny žádné prostředky.

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

enableDeploymentPrerequisites - Povolení požadovaných součástí
string. Volitelný. Používá se při action = Create Or Update Resource Group || action = Select Resource Group. Povolené hodnoty: None, ConfigureVMwithWinRM (konfigurace s agentem WinRM), ConfigureVMWithDGAgent (konfigurace s agentem skupiny nasazení). Výchozí hodnota: None.

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

Volba možnosti Skupina nasazení nakonfiguruje 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 pro provádění operací nasazení na počítačích Azure. Pokud cílové virtuální počítače využívají nástroj 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í ke službě Azure Pipelines
Vstupní alias: deploymentGroupEndpoint. string. Požadováno při (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Určuje připojení služby pro připojení k organizaci Azure DevOps nebo kolekci pro registraci agenta.

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

týmového projektu teamProject -
Vstupní alias: project. string. Požadováno při (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

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

skupiny nasazení deploymentGroupName -
string. Požadováno při (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent.

Určuje skupinu nasazení, pro kterou se budou agenti registrovat. 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. Volitelný. Používá se při (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Výchozí hodnota: true.

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

Ve výchozím nastavení se všechny značky Azure zkopírují podle formátu: Key: Value. Příklad: Role : Web značky Azure se zkopírují as-is do počítače agenta.

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

runAgentServiceAsUser - spustit službu agenta jako uživatel
boolean. Volitelný. Používá se při (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Výchozí hodnota: false.

Spustí službu agenta jako jiný uživatel, než je 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. Požadováno při enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true.

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 na všech virtuálních počítačích ve skupině prostředků se nachází stejný uživatel domény nebo místní uživatel se stejným názvem.

password - heslo
string. Volitelný. Používá se při enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true.

Heslo, které má uživatel spustit službu 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 jako secret, abyste ji zabezpečili.

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

podrobnosti o virtuálním počítači outputVariable - pro winRM
string. Volitelný. Používá se při (action = Create Or Update Resource Group || action = Select Resource Group) && (enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None).

Vyžaduje se, když je vybrána existující skupina prostředků. Poskytuje název proměnné skupiny prostředků. Proměnnou lze použít jako $(variableName) k odkazování na skupinu prostředků v následných úlohách, například v PowerShellu v úloze Cílové počítače pro nasazování aplikací.

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

název nasazení deploymentName -
string. Volitelný. Používá se při action = Create Or Update Resource Group.

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

výstupy nasazení deploymentOutputs -
string. Volitelný. Používá se při action = Create Or Update Resource Group.

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

addSpnToEnvironment - podrobností o instančním objektu Accessu v parametrech přepsání
boolean. Volitelný. Používá se při 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žít jednotlivé výstupní hodnoty bez FORMÁTU JSON. Použité stringify
boolean. Volitelný. Používá se při action = Create Or Update Resource Group. Výchozí hodnota: false.

Jednotlivé výstupní hodnoty se převádějí přes JSON. Stringify ve výchozím nastavení. Pokud chcete použít výstupní hodnoty tak, jak jsou, aniž byste je převáděli přes JSON. Stringify, povolte tuto možnost. Další podrobnosti najdete v této.

Možnosti řízení úkolů

Všechny úkoly mají kromě vstupů úkolů také možnosti řízení. Další informace naleznete v tématu Možnosti ovládacího prvku a běžné vlastnosti úloh.

Výstupní proměnné

Žádný.

Poznámky

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

Novinky v úloze verze 2

• Funguje s agenty pro různé platformy (Linux, macOS nebo Windows)
• Podporuje šablony JSONs umístěné na všech veřejně přístupných adresách URL http/https.
• Vylepšené uživatelské rozhraní 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 podporovány 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 součástí části "Upřesnit možnosti nasazení pro virtuální počítače".
• Omezení:
  • Žádná podpora pro předplatná Classic. Podporují se jenom předplatná ARM.
  • Bez podpory syntaxe PowerShellu, protože úloha je teď node.js založená. Při přepsání parametrů šablony zajistěte, aby se rozlišovala malá a velká písmena názvů parametrů parametrů. Při migraci z verze 1.0 na verzi 2.0 odeberte také rutiny PowerShellu, jako je ConvertTo-SecureString.

Řešení problémů

Chyba: Vnitřní chyba serveru

Tyto problémy jsou většinou přechodné povahy. Může k tomu dojít 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. Sledujte https://status.azure.com/ a zkontrolujte výpadky služeb Azure.
• Samotná služba Azure Pipelines prochází údržbou. Sledujte https://status.dev.azure.com/ výpadků.

Viděli jsme ale některé instance, kdy je příčinou chyba v šabloně ARM, například služba Azure, kterou se pokoušíte nasadit, nepodporuje oblast, kterou jste pro prostředek zvolili.

Chyba: Časový limit

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

• Azure Pipelines Agent
• Nasazení portálu

Pokud je časový limit na portálu, můžete zjistit tak, že vyhledáte odkaz pro nasazení portálu, který bude v protokolech úloh. Pokud neexistuje žádný odkaz, důvodem je pravděpodobně agent Azure Pipelines. Pokud existuje odkaz, postupujte podle odkazu a zjistěte, jestli v nasazení portálu došlo k vypršení časového limitu.

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

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

Warning: Failed to download the file from template path.

Tato funkce vyžaduje povolení pravidel CORS ve zdroji. Pokud jsou šablony v objektu blob úložiště Azure, přečtěte si podporu sdílení prostředků mezi zdroji povolení CORS.

Kromě povolení CORS se ujistěte, že token SAS zadaný v odkazu šablony je srt-sco. Tento token je nutný ke stažení souboru a pokračování.

Azure Pipelines Agent

Pokud problém pochází z agenta Azure Pipelines, můžete časový limit zvýšit nastavením časového limituInMinutes jako klíč v YAML na 0. Další informace naleznete v tématu Zadání úloh v kanálu.

Nasazení portálu

V tomto dokumentu se dozvíte, jak zjistit, jestli chyba pochází z webu Azure Portal: Zobrazit historii nasazení pomocí azure Resource Manageru.

V případě nasazení portálu zkuste v šabloně ARM nastavit časový limitInMinutes na hodnotu 0. Pokud není zadáno, předpokládá se, že hodnota je 60 minut. 0 zajistí, aby nasazení běžela tak dlouho, dokud bude úspěšné.

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

Chyba: Šablona Azure Resource Manageru (ARM) selhala při ověřování

K tomuto problému dochází většinou kvůli neplatnému parametru v šabloně ARM, jako je nepodporovaná skladová položka nebo oblast. Pokud ověření selže, zkontrolujte chybovou zprávu. Měl by vás odkazovat na prostředek a parametr, který je neplatný.

K tomuto problému může dojít také kvůli víceřádkovým řetězcům. V současné době úloha nasazení skupiny prostředků Azure nepodporuje víceřádkové řetězce v souboru JSON šablony ARM ani parametru.

Kromě toho si přečtěte tento článek o struktuře a syntaxi šablon ARM: Porozumět struktuře a syntaxi šablon ARM.

Požadavky

Požadavek	Popis
Typy kanálů	YAML, klasické sestavení, 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ů	Jakýkoliv
nastavitelné proměnné	Jakýkoliv
Verze agenta	2.119.1 nebo vyšší
Kategorie úkolu	Nasadit