AzureResourceManagerTemplateDeployment@3 – úloha nasazení šablony ARM verze 3

Tuto úlohu použijte k nasazení šablony Azure Resource Manager (ARM) do všech oborů nasazení.

Syntax

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

Vstupy

deploymentScope - Obor nasazení
string. Povinná hodnota. Povolené hodnoty: Management Group, Subscription, Resource Group. Výchozí hodnota: Resource Group.

Rozsah nasazení. Přečtěte si další informace o oborech nasazení.

azureResourceManagerConnection - Připojení azure Resource Manager
Vstupní alias: ConnectedServiceName. string. Povinná hodnota.

Určuje připojení služby Azure Resource Manager s přístupem k vybranému oboru nasazení.

subscriptionId - Předplatné
Vstupní alias: subscriptionName. string. Vyžaduje se, když deploymentScope != Management Group.

Určuje předplatné Azure.

Důležité

Zadaná hodnota musí být ID předplatného, nikoli název předplatného.

action - Akce
string. Vyžaduje se, když deploymentScope = Resource Group. Povolené hodnoty: Create Or Update Resource Group, 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. Vyžaduje se, když deploymentScope = Resource Group.

Poskytuje název skupiny prostředků.

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

Obory nasazení skupiny prostředků: Umístění pro nasazení skupiny prostředků. Pokud skupina prostředků už v předplatném Azure existuje, bude tato hodnota ignorována. Další obory nasazení: Umístění pro uložení metadat nasazení.

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

Umístění šablony a souborů JSON parametrů Pokud jsou soubory součástí artefaktů propojeného kódu nebo sestavení, zvolte Propojený artefakt . U propojených artefaktů můžete také zadat cestu k souboru Bicep. Zvolte adresu URL souboru, pokud jsou soubory JSON umístěné na veřejně přístupných adresách URL http/https. 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?. 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 kroků pomocí PowerShellu nebo Azure CLI.

csmFileLink - Odkaz na šablonu
string. Vyžaduje se, když templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != 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řepsat parametry š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 Sdílení prostředků mezi zdroji a povolte CORS.

csmParametersFileLink - Odkaz na parametry šablony
string. Nepovinný parametr. Použijte, když templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != 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 š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 ... textové pole Přepsat parametry š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 Sdílení prostředků mezi zdroji a povolte CORS.

csmFile - Šablony
string. Vyžaduje se, když templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != 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. Podporuje soubory Bicep v Azure CLI verze > 2.20.0.

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

Zadejte cestu nebo vzor ukazující na soubor parametrů pro šablonu Azure Resource Manager. Podporuje soubory Bicep Param v Azure CLI verze > 2.47.0.

overrideParameters - Přepsání parametrů šablony
string. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group || deploymentScope != 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 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, a to i v případě, že 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 objekty JSON s řetězci. Například, -options ["option1"] -map {"key1": "value1" }.

deploymentMode - Režim nasazení
string. Vyžaduje se, když action = Create Or Update Resource Group || deploymentScope != 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ě. Režim dokončení 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 režimu Incremental .

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í.

deploymentName - Název nasazení
string. Nepovinný parametr. Použijte, když action = Create Or Update Resource Group || deploymentScope != 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 || deploymentScope != Resource Group.

Poskytuje název proměnné pro výstupní proměnnou, která obsahuje oddíl outputs aktuálního objektu nasazení ve formátu řetězce. K parsování objektu ConvertFrom-Json JSON a přístupu k jednotlivým výstupním hodnotám můžete použít rutinu PowerShellu. Přečtěte si další informace o výstupech nasazení.

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 || deploymentScope != 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 || deploymentScope != 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

Poznámka

Tato úloha podporuje soubory Bicep v Azure CLI verze > 2.20.0.

• Byla přidána podpora nasazení ve všech oborech nasazení.
  • Odebrali jsme všechny akce související s virtuálními počítači.

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í