Distribuera resurser med Bicep och Azure PowerShell

  • Artikel

Den här artikeln beskriver hur du använder Azure PowerShell med Bicep-filer för att distribuera dina resurser till Azure. Om du inte är bekant med begreppen att distribuera och hantera dina Azure-lösningar kan du läsa översikten över Bicep.

Förutsättningar

Du behöver en Bicep-fil för att distribuera. Filen måste vara lokal.

Du behöver Azure PowerShell och vara ansluten till Azure:

Om du inte har PowerShell installerat kan du använda Azure Cloud Shell. Mer information finns i Distribuera Bicep-filer från Azure Cloud Shell.

Behörigheter som krävs

Om du vill distribuera en Bicep-fil eller en ARM-mall måste du ha skrivåtkomst till de resurser som du distribuerar och åtkomst till alla åtgärder i resurstypen Microsoft.Resources/deployments. Om du till exempel vill distribuera en virtuell dator behöver Microsoft.Compute/virtualMachines/write du och Microsoft.Resources/deployments/* behörigheter. Konsekvensåtgärden har samma behörighetskrav.

Det finns en lista med roller och behörigheter i Inbyggda roller i Azure.

Distributionsomfång

Du kan rikta distributionen mot en resursgrupp, prenumeration, hanteringsgrupp eller klientorganisation. Beroende på omfånget för distributionen använder du olika kommandon.

För varje omfång måste användaren som distribuerar mallen ha de behörigheter som krävs för att skapa resurser.

Distribuera lokal Bicep-fil

Du kan distribuera en Bicep-fil från den lokala datorn eller en som lagras externt. I det här avsnittet beskrivs hur du distribuerar en lokal Bicep-fil.

Om du distribuerar till en resursgrupp som inte finns skapar du resursgruppen. Namnet på resursgruppen kan bara innehålla alfanumeriska tecken, punkter, understreck, bindestreck och parenteser. Det kan vara upp till 90 tecken. Namnet kan inte sluta i en punkt.

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

Om du vill distribuera en lokal Bicep-fil använder du växeln -TemplateFile i distributionskommandot.

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

Distributionen kan ta flera minuter att slutföra.

Distribuera fjärr-Bicep-fil

För närvarande stöder Inte Azure PowerShell distribution av fjärranslutna Bicep-filer. Använd Bicep CLI för att skapa Bicep-filen till en JSON-mall och läs sedan in JSON-filen till fjärrplatsen.

Parametrar

Om du vill skicka parametervärden kan du använda antingen infogade parametrar eller en parameterfil. Parameterfilen kan vara antingen en Bicep-parameterfil eller en JSON-parameterfil.

Infogade parametrar

Om du vill skicka infogade parametrar anger du namnen på parametern med New-AzResourceGroupDeployment kommandot . Om du till exempel vill skicka en sträng och matris till en Bicep-fil använder du:

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

Du kan också hämta innehållet i filen och ange innehållet som en infogad parameter.

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

Det är praktiskt att hämta ett parametervärde från en fil när du behöver ange konfigurationsvärden. Du kan till exempel ange cloud-init-värden för en virtuell Linux-dator.

Om du behöver skicka in en matris med objekt skapar du hash-tabeller i PowerShell och lägger till dem i en matris. Skicka matrisen som en parameter under distributionen.

$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-bicep> `
  -exampleArray $subnetArray

Bicep-parameterfiler

I stället för att skicka parametrar som infogade värden i skriptet kan det vara enklare att använda en parameterfil, antingen en .bicepparam fil eller en JSON-parameterfil, som innehåller parametervärdena. Bicep-parameterfilen måste vara en lokal fil.

Med Azure PowerShell version 10.4.0 eller senare och Bicep CLI version 0.22.X eller senare kan du distribuera en Bicep-fil genom att använda en Bicep-parameterfil. Med -instruktionen using i Bicep-parameterfilen behöver du inte ange växeln -TemplateFile när du anger en Bicep-parameterfil för växeln -TemplateParameterFile .

I följande exempel visas en parameterfil med namnet storage.bicepparam. Filen finns i samma katalog där kommandot körs.

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

Mer information om parameterfilen finns i Skapa Resource Manager-parameterfil.

JSON-parameterfiler

JSON-parameterfilen kan vara en lokal fil eller en extern fil med en tillgänglig URI. Mer information om parameterfilen finns i Skapa Resource Manager-parameterfil.

Om du vill skicka en lokal parameterfil använder du växeln TemplateParameterFile med en JSON-parameterfil:

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile c:\BicepFiles\storage.bicep `
  -TemplateParameterFile c:\BicepFiles\storage.parameters.json

Om du vill skicka en extern parameterfil använder du parametern TemplateParameterUri :

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

Parametern TemplateParameterUri stöder .bicepparam inte filer, den stöder bara JSON-parameterfiler.

Du kan använda infogade parametrar och en platsparametrarfil i samma distributionsåtgärd. Mer information finns i Parameterprioret.

Förhandsgranska ändringar

Innan du distribuerar Bicep-filen kan du förhandsgranska de ändringar som Bicep-filen kommer att göra i din miljö. Använd konsekvensåtgärden för att kontrollera att Bicep-filen gör de ändringar som du förväntar dig. What-if validerar även Bicep-filen för fel.

Distribuera mallspecifikationer

För närvarande har Azure PowerShell inte stöd för att skapa mallspecifikationer genom att tillhandahålla Bicep-filer. Du kan dock skapa en Bicep-fil med resursen Microsoft.Resources/templateSpecs för att distribuera en mallspecifikation. Exemplet på specifikationen Skapa mall visar hur du skapar en mallspecifikation i en Bicep-fil. Du kan också skapa Bicep-filen till JSON med hjälp av Bicep CLI och sedan skapa en mallspecifikation med JSON-mallen.

Distributionsnamnet

När du distribuerar en Bicep-fil kan du ge distributionen ett namn. Det här namnet kan hjälpa dig att hämta distributionen från distributionshistoriken. Om du inte anger något namn för distributionen används namnet på Bicep-filen. Om du till exempel distribuerar en Bicep med namnet main.bicep och inte anger något distributionsnamn, heter maindistributionen .

Varje gång du kör en distribution läggs en post till i resursgruppens distributionshistorik med distributionsnamnet. Om du kör en annan distribution och ger den samma namn ersätts den tidigare posten med den aktuella distributionen. Om du vill behålla unika poster i distributionshistoriken ger du varje distribution ett unikt namn.

Om du vill skapa ett unikt namn kan du tilldela ett slumptal.

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

Eller lägg till ett datumvärde.

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

Om du kör samtidiga distributioner till samma resursgrupp med samma distributionsnamn slutförs endast den senaste distributionen. Alla distributioner med samma namn som inte har slutförts ersätts av den senaste distributionen. Om du till exempel kör en distribution med namnet newStorage som distribuerar ett lagringskonto med namnet storage1och samtidigt kör en annan distribution med namnet newStorage som distribuerar ett lagringskonto med namnet storage2distribuerar du bara ett lagringskonto. Det resulterande lagringskontot heter storage2.

Men om du kör en distribution med namnet newStorage som distribuerar ett lagringskonto med namnet storage1och omedelbart efter att den har slutförts kör du en annan distribution med namnet newStorage som distribuerar ett lagringskonto med namnet storage2, så har du två lagringskonton. Den ena heter storage1och den andra heter storage2. Men du har bara en post i distributionshistoriken.

När du anger ett unikt namn för varje distribution kan du köra dem samtidigt utan konflikter. Om du kör en distribution med namnet newStorage1 som distribuerar ett lagringskonto med namnet storage1och samtidigt kör en annan distribution med namnet newStorage2 som distribuerar ett lagringskonto med namnet storage2, har du två lagringskonton och två poster i distributionshistoriken.

För att undvika konflikter med samtidiga distributioner och för att säkerställa unika poster i distributionshistoriken ger du varje distribution ett unikt namn.

Nästa steg