Nasazení prostředků pomocí šablon ARM a Azure PowerShellu

Tento článek vysvětluje, jak pomocí Azure PowerShellu s šablonami Azure Resource Manageru (šablony ARM) nasadit prostředky do Azure. Pokud neznáte koncepty nasazení a správy řešení Azure, prohlédněte si přehled nasazení šablon.

Tip

Doporučujeme Bicep, protože nabízí stejné možnosti jako šablony ARM a syntaxe se snadněji používá. Další informace najdete v tématu Nasazení prostředků pomocí Bicep a Azure PowerShellu.

Předpoklady

K nasazení potřebujete šablonu. Pokud ho ještě nemáte, stáhněte si a uložte ukázkovou šablonu z úložiště šablon Azure Pro rychlý start. Název místního souboru použitý v tomto článku je C:\MyTemplates\azuredeploy.json.

Musíte nainstalovat Azure PowerShell a připojit se k Azure:

• Nainstalujte rutiny Azure PowerShellu do místního počítače. Další informace najdete v tématu Začínáme s Azure PowerShellem.
• Připojení do Azure pomocí Připojení-AZAccount. Pokud máte více předplatných Azure, možná budete také muset spustit Set-AzContext. Další informace najdete v tématu Použití několika předplatných Azure.

Pokud nemáte nainstalovaný PowerShell, můžete použít Azure Cloud Shell. Další informace najdete v tématu Nasazení šablon ARM z Azure Cloud Shellu.

Požadována oprávnění

Pokud chcete nasadit soubor Bicep nebo šablonu ARM, musíte mít přístup k zápisu pro prostředky, které nasazujete, a přístup ke všem operacím s prostředky typu Microsoft.Resources/deployments. Pokud chcete například nasadit virtuální počítač, potřebujete Microsoft.Compute/virtualMachines/write a Microsoft.Resources/deployments/* oprávnění. Operace citlivostní operace má stejné požadavky na oprávnění.

Seznam rolí a oprávnění najdete v tématu Předdefinované role Azure.

Obor nasazení

Nasazení můžete cílit na skupinu prostředků, předplatné, skupinu pro správu nebo tenanta. V závislosti na rozsahu nasazení použijete různé příkazy.

• K nasazení do skupiny prostředků použijte Rutinu New-AzResourceGroupDeployment:

  New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateFile <path-to-template>
  

• K nasazení do předplatného použijte Rutinu New-AzSubscriptionDeployment, což je alias New-AzDeployment rutiny:

  New-AzSubscriptionDeployment -Location <location> -TemplateFile <path-to-template>
  

  Další informace o nasazeních na úrovni předplatného najdete v tématu Vytváření skupin prostředků a prostředků na úrovni předplatného.

• K nasazení do skupiny pro správu použijte Rutinu New-AzManagementGroupDeployment.

  New-AzManagementGroupDeployment -Location <location> -TemplateFile <path-to-template>
  

  Další informace o nasazeních na úrovni skupiny pro správu najdete v tématu Vytváření prostředků na úrovni skupiny pro správu.

• K nasazení do tenanta použijte New-AzTenantDeployment.

  New-AzTenantDeployment -Location <location> -TemplateFile <path-to-template>
  

  Další informace o nasazeních na úrovni tenanta najdete v tématu Vytváření prostředků na úrovni tenanta.

Pro každý obor musí mít uživatel, který šablonu nasazuje, požadovaná oprávnění k vytváření prostředků.

Název nasazení

Při nasazování šablony ARM můžete nasazení pojmenovat. Tento název vám může pomoct načíst nasazení z historie nasazení. Pokud nezadáte název nasazení, použije se název souboru šablony. Pokud například nasadíte šablonu s názvem azuredeploy.json a nezadáte název nasazení, bude se nasazení jmenovat azuredeploy.

Při každém spuštění nasazení se položka přidá do historie nasazení skupiny prostředků s názvem nasazení. Pokud spustíte jiné nasazení a dáte mu stejný název, nahradí se předchozí položka aktuálním nasazením. Pokud chcete zachovat jedinečné položky v historii nasazení, dejte každému nasazení jedinečný název.

Pokud chcete vytvořit jedinečný název, můžete přiřadit náhodné číslo.

$suffix = Get-Random -Maximum 1000
$deploymentName = "ExampleDeployment" + $suffix

Nebo přidejte hodnotu data.

$today=Get-Date -Format "MM-dd-yyyy"
$deploymentName="ExampleDeployment"+"$today"

Pokud spustíte souběžná nasazení do stejné skupiny prostředků se stejným názvem nasazení, dokončí se pouze poslední nasazení. Všechna nasazení se stejným názvem, který se nedokončil, se nahradí posledním nasazením. Pokud například spustíte nasazení s názvem newStorage , které nasadí účet úložiště s názvem storage1, a současně spustíte jiné nasazení, které nasadí účet úložiště s názvem newStoragestorage2, nasadíte pouze jeden účet úložiště. Výsledný účet úložiště má název storage2.

Pokud však spustíte nasazení s názvem newStorage , které nasadí účet úložiště s názvem storage1, a hned po jeho dokončení spustíte jiné nasazení, které nasadí účet úložiště s názvem newStoragestorage2, pak máte dva účty úložiště. Jeden má název storage1a druhý má název storage2. V historii nasazení ale máte jenom jednu položku.

Když pro každé nasazení zadáte jedinečný název, můžete je spustit souběžně bez konfliktu. Pokud spustíte nasazení s názvem newStorage1 , které nasadí účet úložiště s názvem storage1, a současně spustíte jiné nasazení, které nasadí účet úložiště s názvem newStorage2storage2, budete mít dva účty úložiště a dvě položky v historii nasazení.

Aby nedocházelo ke konfliktům se souběžnými nasazeními a k zajištění jedinečných položek v historii nasazení, dejte každému nasazení jedinečný název.

Nasazení místní šablony

Šablonu můžete nasadit z místního počítače nebo z místního počítače, který je uložený externě. Tato část popisuje nasazení místní šablony.

Pokud nasazujete do skupiny prostředků, která neexistuje, vytvořte skupinu prostředků. Název skupiny prostředků může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a závorky. Může to být až 90 znaků. Název nemůže končit tečkou.

New-AzResourceGroup -Name ExampleGroup -Location "Central US"

Pokud chcete nasadit místní šablonu, použijte -TemplateFile parametr v příkazu nasazení. Následující příklad také ukazuje, jak nastavit hodnotu parametru, která pochází ze šablony.

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleGroup `
  -TemplateFile <path-to-template>

Dokončení nasazení může trvat několik minut.

Nasazení vzdálené šablony

Místo ukládání šablon ARM na místním počítači je můžete raději uložit do externího umístění. Šablony můžete uložit do úložiště pro správu zdrojového kódu (jako je GitHub). Nebo je můžete uložit do účtu úložiště v Azure, abyste k nim mohli v organizaci sdílet přístup.

Poznámka:

Pokud chcete nasadit šablonu nebo odkazovat na propojenou šablonu uloženou v privátním úložišti GitHubu, podívejte se na vlastní řešení popsané v tématu Vytvoření vlastní a zabezpečené nabídky webu Azure Portal. Můžete vytvořit funkci Azure, která stáhne token GitHubu ze služby Azure Key Vault.

Pokud nasazujete do skupiny prostředků, která neexistuje, vytvořte skupinu prostředků. Název skupiny prostředků může obsahovat pouze alfanumerické znaky, tečky, podtržítka, pomlčky a závorky. Může to být až 90 znaků. Název nemůže končit tečkou.

New-AzResourceGroup -Name ExampleGroup -Location "Central US"

K nasazení externí šablony použijte parametr -TemplateUri.

New-AzResourceGroupDeployment `
  -Name remoteTemplateDeployment `
  -ResourceGroupName ExampleGroup `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json

Předchozí příklad vyžaduje veřejně přístupný identifikátor URI pro šablonu, který funguje ve většině scénářů, protože vaše šablona by neměla obsahovat citlivá data. Pokud potřebujete zadat citlivá data (například heslo správce), předejte tuto hodnotu jako zabezpečený parametr. Pokud ale chcete spravovat přístup k šabloně, zvažte použití specifikací šablon.

Pokud chcete nasadit vzdálené propojené šablony s relativní cestou uloženou v účtu úložiště, použijte QueryString k určení tokenu SAS:

New-AzResourceGroupDeployment `
  -Name linkedTemplateWithRelativePath `
  -ResourceGroupName "myResourceGroup" `
  -TemplateUri "https://stage20210126.blob.core.windows.net/template-staging/mainTemplate.json" `
  -QueryString "$sasToken"

Další informace naleznete v tématu Použití relativní cesty pro propojené šablony.

Nasazení specifikace šablony

Místo nasazení místní nebo vzdálené šablony můžete vytvořit specifikaci šablony. Specifikace šablony je prostředek ve vašem předplatném Azure, který obsahuje šablonu ARM. Usnadňuje bezpečné sdílení šablony s uživateli ve vaší organizaci. Pomocí řízení přístupu na základě role v Azure (Azure RBAC) udělíte přístup ke specifikaci šablony. Tato funkce je aktuálně ve verzi Preview.

Následující příklady ukazují, jak vytvořit a nasadit specifikaci šablony.

Nejprve vytvořte specifikaci šablony zadáním šablony ARM.

New-AzTemplateSpec `
  -Name storageSpec `
  -Version 1.0 `
  -ResourceGroupName templateSpecsRg `
  -Location westus2 `
  -TemplateJsonFile ./mainTemplate.json

Pak získejte ID specifikace šablony a nasaďte ho.

$id = (Get-AzTemplateSpec -Name storageSpec -ResourceGroupName templateSpecsRg -Version 1.0).Versions.Id

New-AzResourceGroupDeployment `
  -ResourceGroupName demoRG `
  -TemplateSpecId $id

Další informace najdete v tématu Specifikace šablon Azure Resource Manageru.

Náhled změn

Před nasazením šablony můžete zobrazit náhled změn, které šablona provede ve vašem prostředí. Pomocí operace citlivostní analýza ověřte, že šablona provede očekávané změny. Citlivostní analýza také ověří chyby šablony.

Předání hodnot parametrů

K předání hodnot parametrů můžete použít vložené parametry nebo soubor parametrů. Soubor parametrů může být soubor parametrů Bicep nebo soubor parametrů JSON.

Vložené parametry

Pokud chcete předat vložené parametry, zadejte názvy parametru pomocí New-AzResourceGroupDeployment příkazu. Pokud například chcete šabloně předat řetězec a pole, použijte:

$arrayParam = "value1", "value2"
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile <path-to-template> `
  -exampleString "inline string" `
  -exampleArray $arrayParam

Můžete také získat obsah souboru a poskytnout ho jako vložený parametr.

$arrayParam = "value1", "value2"
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile <path-to-template> `
  -exampleString $(Get-Content -Path c:\MyTemplates\stringcontent.txt -Raw) `
  -exampleArray $arrayParam

Získání hodnoty parametru ze souboru je užitečné, když potřebujete zadat konfigurační hodnoty. Můžete například zadat hodnoty cloud-init pro virtuální počítač s Linuxem.

Pokud potřebujete předat pole objektů, vytvořte v PowerShellu tabulky hash a přidejte je do pole. Toto pole předejte jako parametr během nasazování.

$hash1 = @{ Name = "firstSubnet"; AddressPrefix = "10.0.0.0/24"}
$hash2 = @{ Name = "secondSubnet"; AddressPrefix = "10.0.1.0/24"}
$subnetArray = $hash1, $hash2
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile <path-to-template> `
  -exampleArray $subnetArray

Soubory parametrů JSON

Místo předávání parametrů v podobě hodnot vložených do skriptu pro vás možná bude jednodušší použít soubor JSON, který obsahuje hodnoty parametrů. Soubor parametrů může být místní soubor nebo externí soubor s přístupným identifikátorem URI.

Další informace o souboru parametrů najdete v tématu Vytvoření souboru parametrů Resource Manageru.

Pokud chcete předat místní soubor parametrů, použijte tento TemplateParameterFile parametr:

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile <path-to-template> `
  -TemplateParameterFile c:\MyTemplates\storage.parameters.json

Pokud chcete předat soubor externího parametru, použijte tento TemplateParameterUri parametr:

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json `
  -TemplateParameterUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.parameters.json

Další informace o souboru parametrů naleznete v tématu Vytvoření souboru parametrů Resource Manageru.

Soubory parametrů Bicep

Pomocí Azure PowerShellu verze 10.4.0 nebo novější a rozhraní příkazového řádku Bicep verze 0.22.6 nebo novější můžete nasadit soubor šablony ARM pomocí souboru parametrů Bicep. using Pomocí příkazu v souboru parametrů Bicep není nutné při zadávání souboru parametrů Bicep pro -TemplateParameterFile přepínač zadat -TemplateFile přepínač.

Následující příklad ukazuje soubor parametrů s názvem storage.bicepparam. Soubor je ve stejném adresáři, ve kterém je příkaz spuštěn.

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateParameterFile storage.bicepparam

Další informace o souboru parametrů Bicep naleznete v souboru parametrů Bicep.

Další kroky

• Pokud se chcete vrátit k úspěšnému nasazení, pokud se zobrazí chyba, přečtěte si téma Vrácení zpět k chybě k úspěšnému nasazení.
• Pokud chcete určit, jak zpracovávat prostředky, které existují ve skupině prostředků, ale nejsou definované v šabloně, podívejte se na režimy nasazení Azure Resource Manageru.
• Informace o definování parametrů v šabloně najdete v tématu Vysvětlení struktury a syntaxe šablon ARM.
• Informace o nasazení šablony, která vyžaduje token SAS, najdete v tématu Nasazení privátní šablony ARM s tokenem SAS.