Resources implementeren met Bicep en Azure PowerShell

  • Artikel

In dit artikel wordt uitgelegd hoe u Azure PowerShell gebruikt met Bicep-bestanden om uw resources te implementeren in Azure. Als u niet bekend bent met de concepten van het implementeren en beheren van uw Azure-oplossingen, raadpleegt u het Bicep-overzicht.

Vereisten

U hebt een Bicep-bestand nodig om te implementeren. Het bestand moet lokaal zijn.

U hebt Azure PowerShell nodig en moet zijn verbonden met Azure:

Als u PowerShell niet hebt geïnstalleerd, kunt u Azure Cloud Shell gebruiken. Zie Bicep-bestanden implementeren vanuit Azure Cloud Shell voor meer informatie.

Vereiste machtigingen

Als u een Bicep-bestand of ARM-sjabloon wilt implementeren, hebt u schrijftoegang nodig voor de resources die u implementeert en moet u zijn gemachtigd om alle bewerkingen op het resourcetype Microsoft.Resources/deployments te kunnen uitvoeren. Als u bijvoorbeeld een virtuele machine wilt implementeren, hebt u de benodigde machtigingen en Microsoft.Resources/deployments/* machtigingen nodigMicrosoft.Compute/virtualMachines/write. De wat-als-bewerking heeft dezelfde machtigingsvereisten.

Zie Ingebouwde Azure-rollen voor een lijst met rollen en machtigingen.

Implementatiebereik

U kunt uw implementatie richten op een resourcegroep, abonnement, beheergroep of tenant. Afhankelijk van het bereik van de implementatie gebruikt u verschillende opdrachten.

Voor elk bereik moet de gebruiker die de sjabloon implementeert, over de vereiste machtigingen beschikken om resources te maken.

Lokaal Bicep-bestand implementeren

U kunt een Bicep-bestand implementeren vanaf uw lokale computer of een bestand dat extern is opgeslagen. In deze sectie wordt beschreven hoe u een lokaal Bicep-bestand implementeert.

Als u implementeert in een resourcegroep die niet bestaat, maakt u de resourcegroep. De naam van de resourcegroep kan alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepjes en haakjes bevatten. Het mag maximaal 90 tekens zijn. De naam kan niet eindigen in een punt.

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

Als u een lokaal Bicep-bestand wilt implementeren, gebruikt u de -TemplateFile switch in de implementatieopdracht.

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

Het kan enkele minuten duren voordat de implementatie is voltooid.

Extern Bicep-bestand implementeren

Momenteel biedt Azure PowerShell geen ondersteuning voor het implementeren van externe Bicep-bestanden. Gebruik Bicep CLI om het Bicep-bestand te bouwen naar een JSON-sjabloon en laad het JSON-bestand vervolgens naar de externe locatie.

Parameters

Als u parameterwaarden wilt doorgeven, kunt u inlineparameters of een parameterbestand gebruiken. Het parameterbestand kan een Bicep-parametersbestand of een JSON-parametersbestand zijn.

Inlineparameters

Als u inlineparameters wilt doorgeven, geeft u de namen van de parameter op met de New-AzResourceGroupDeployment opdracht. Als u bijvoorbeeld een tekenreeks en matrix wilt doorgeven aan een Bicep-bestand, gebruikt u:

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

U kunt ook de inhoud van het bestand ophalen en die inhoud opgeven als een inlineparameter.

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

Het ophalen van een parameterwaarde uit een bestand is handig wanneer u configuratiewaarden moet opgeven. U kunt bijvoorbeeld cloud-init-waarden opgeven voor een virtuele Linux-machine.

Als u een matrix met objecten wilt doorgeven, maakt u hash-tabellen in PowerShell en voegt u deze toe aan een matrix. Geef die matrix door als parameter tijdens de implementatie.

$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-parameterbestanden

In plaats van parameters door te geven als inlinewaarden in uw script, is het wellicht gemakkelijker om een parameterbestand, een .bicepparam bestand of een JSON-parameterbestand, te gebruiken dat de parameterwaarden bevat. Het Bicep-parametersbestand moet een lokaal bestand zijn.

Met Azure PowerShell versie 10.4.0 of hoger en Bicep CLI versie 0.22.X of hoger kunt u een Bicep-bestand implementeren met behulp van een Bicep-parameterbestand. Met de using instructie in het Bicep-parametersbestand hoeft u de -TemplateFile schakeloptie niet op te geven bij het opgeven van een Bicep-parameterbestand voor de -TemplateParameterFile switch.

In het volgende voorbeeld ziet u een parameterbestand met de naam storage.bicepparam. Het bestand bevindt zich in dezelfde map waarin de opdracht wordt uitgevoerd.

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

Zie Het parameterbestand Resource Manager maken voor meer informatie over het parameterbestand.

JSON-parametersbestanden

Het JSON-parameterbestand kan een lokaal bestand of een extern bestand met een toegankelijke URI zijn. Zie Het parameterbestand Resource Manager maken voor meer informatie over het parameterbestand.

Als u een lokaal parameterbestand wilt doorgeven, gebruikt u de TemplateParameterFile schakeloptie met een JSON-parameterbestand:

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

Als u een bestand met externe parameters wilt doorgeven, gebruikt u de TemplateParameterUri parameter:

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

De TemplateParameterUri parameter biedt geen ondersteuning voor .bicepparam bestanden, maar ondersteunt alleen JSON-parametersbestanden.

U kunt inlineparameters en een locatieparametersbestand gebruiken in dezelfde implementatiebewerking. Zie Parameterprioriteit voor meer informatie.

Voorbeeld van wijzigingen weergeven

Voordat u uw Bicep-bestand implementeert, kunt u een voorbeeld bekijken van de wijzigingen die het Bicep-bestand in uw omgeving aanbrengt. Gebruik de wat-als-bewerking om te controleren of het Bicep-bestand de verwachte wijzigingen aanbrengt. What-if valideert ook het Bicep-bestand op fouten.

Sjabloonspecificaties implementeren

Momenteel biedt Azure PowerShell geen ondersteuning voor het maken van sjabloonspecificaties door Bicep-bestanden op te geven. U kunt echter een Bicep-bestand maken met de resource Microsoft.Resources/templateSpecs om een sjabloonspecificatie te implementeren. In het voorbeeld sjabloonspecificatie maken ziet u hoe u een sjabloonspecificatie maakt in een Bicep-bestand. U kunt uw Bicep-bestand ook bouwen naar JSON met behulp van de Bicep CLI en vervolgens een sjabloonspecificatie maken met de JSON-sjabloon.

Naam van implementatie

Wanneer u een Bicep-bestand implementeert, kunt u de implementatie een naam geven. Met deze naam kunt u de implementatie ophalen uit de implementatiegeschiedenis. Als u geen naam opgeeft voor de implementatie, wordt de naam van het Bicep-bestand gebruikt. Als u bijvoorbeeld een Bicep-naam main.bicep implementeert en geen implementatienaam opgeeft, krijgt de implementatie de naam main.

Telkens wanneer u een implementatie uitvoert, wordt er een vermelding toegevoegd aan de implementatiegeschiedenis van de resourcegroep met de implementatienaam. Als u een andere implementatie uitvoert en deze dezelfde naam geeft, wordt de eerdere vermelding vervangen door de huidige implementatie. Als u unieke vermeldingen in de implementatiegeschiedenis wilt behouden, geeft u elke implementatie een unieke naam.

Als u een unieke naam wilt maken, kunt u een willekeurig getal toewijzen.

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

U kunt ook een datumwaarde toevoegen.

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

Als u gelijktijdige implementaties uitvoert naar dezelfde resourcegroep met dezelfde implementatienaam, wordt alleen de laatste implementatie voltooid. Implementaties met dezelfde naam die nog niet zijn voltooid, worden vervangen door de laatste implementatie. Als u bijvoorbeeld een implementatie uitvoert die newStorage een opslagaccount met de naam storage1implementeert en tegelijkertijd een andere implementatie newStorage uitvoert die een opslagaccount met de naam storage2implementeert, implementeert u slechts één opslagaccount. Het resulterende opslagaccount heeft de naam storage2.

Als u echter een implementatie uitvoert die newStorage een opslagaccount met de naam storage1implementeert en onmiddellijk nadat u een andere implementatie hebt uitgevoerd met de naam newStorage die een opslagaccount met de naam storage2implementeert, hebt u twee opslagaccounts. De ene heet storage1en de andere heet storage2. Maar u hebt slechts één vermelding in de implementatiegeschiedenis.

Wanneer u een unieke naam opgeeft voor elke implementatie, kunt u deze gelijktijdig uitvoeren zonder conflict. Als u een implementatie newStorage1 uitvoert die een opslagaccount met de naam storage1implementeert en tegelijkertijd een andere implementatie uitvoert die newStorage2 een opslagaccount met de naam storage2implementeert, hebt u twee opslagaccounts en twee vermeldingen in de implementatiegeschiedenis.

Geef elke implementatie een unieke naam om conflicten met gelijktijdige implementaties te voorkomen en unieke vermeldingen in de implementatiegeschiedenis te garanderen.

Volgende stappen