Delen via


Bicep-bestanden implementeren met de Azure CLI

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

Vereisten

U hebt een Bicep-bestand nodig om te implementeren en het bestand moet lokaal zijn. U hebt ook de Azure CLI nodig en moet zijn verbonden met Azure:

  • Installeer Azure CLI-opdrachten op uw lokale computer. Als u Bicep-bestanden wilt implementeren, hebt u Azure CLI versie 2.20.0 of hoger nodig.
  • Gebruik az login dit om verbinding te maken met Azure. Als u meerdere Azure-abonnementen hebt, moet u mogelijk ook worden uitgevoerd az account set.

Voorbeelden voor de Azure CLI zijn geschreven voor de bash-shell. Als u dit voorbeeld wilt uitvoeren in Windows PowerShell of opdrachtprompt (cmd), moet u mogelijk elementen van het script wijzigen.

Als u de Azure CLI niet hebt geïnstalleerd, kunt u Azure Cloud Shell gebruiken. Zie Bicep-bestanden implementeren met 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 en moet de gebruiker die het Bicep-bestand implementeert, over de vereiste machtigingen beschikken om resources voor elk bereik te maken.

Lokaal Bicep-bestand implementeren

U kunt een Bicep-bestand implementeren vanaf uw lokale computer of een externe. 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 kan maximaal 90 tekens zijn en kan niet eindigen in een periode.

az group create --name ExampleGroup --location "Central US"

Als u een lokaal Bicep-bestand wilt implementeren, gebruikt u de --template-file switch in de implementatieopdracht. In het volgende voorbeeld ziet u ook hoe u een parameterwaarde instelt:

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file <path-to-bicep> \
  --parameters storageAccountType=Standard_GRS

De implementatie kan enkele minuten duren. Wanneer dit is voltooid, ziet u een bericht met het volgende resultaat:

"provisioningState": "Succeeded",

Extern Bicep-bestand implementeren

De Azure CLI biedt momenteel geen ondersteuning voor het implementeren van externe Bicep-bestanden. U kunt de Bicep CLI gebruiken om het Bicep-bestand te bouwen naar een JSON-sjabloon en vervolgens het JSON-bestand naar een externe locatie te laden. Zie Externe sjabloon implementeren voor meer informatie.

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 waarden op in parameters. Als u bijvoorbeeld een tekenreeks en matrix wilt doorgeven aan een Bicep-bestand in een Bash-shell, gebruikt u:

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters exampleString='inline string' exampleArray='["value1", "value2"]'

Als u de Azure CLI gebruikt met de cmd of PowerShell, geeft u de matrix door in de volgende indeling: exampleArray="['value1','value2']"

U kunt ook de inhoud van het bestand ophalen om die inhoud op te geven als een inlineparameter. De bestandsnaam vooraf laten gaan door @:

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters exampleString=@stringContent.txt exampleArray=@arrayContent.json

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.

De arrayContent.json-indeling is:

[
  "value1",
  "value2"
]

Als u een object wilt doorgeven, gebruikt u JSON (bijvoorbeeld bij het instellen van tags). Uw Bicep-bestand bevat mogelijk een parameter zoals deze:

"resourceTags": {
  "type": "object",
  "defaultValue": {
    "Cost Center": "IT Department"
  }
}

Zoals wordt weergegeven in het volgende Bash-script, kunt u ook een JSON-tekenreeks doorgeven om de parameter in te stellen. Gebruik dubbele aanhalingstekens rond de JSON die u wilt doorgeven aan het object:

tags='{"Owner":"Contoso","Cost Center":"2345-324"}'
az deployment group create --name addstorage  --resource-group myResourceGroup \
--template-file $bicepFile \
--parameters resourceName=abcdef4556 resourceTags="$tags"

Als u de Azure CLI met cmd of PowerShell gebruikt, geeft u het object door in de volgende indeling:

$tags="{'Owner':'Contoso','Cost Center':'2345-324'}"
az deployment group create --name addstorage  --resource-group myResourceGroup \
--template-file $bicepFile \
--parameters resourceName=abcdef4556 resourceTags=$tags

U kunt een variabele gebruiken om de parameterwaarden te bevatten. Stel de variabele in op alle parameterwaarden in uw Bash-script en voeg deze toe aan de implementatieopdracht:

params="prefix=start suffix=end"

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters $params

Als u echter de Azure CLI gebruikt met cmd of PowerShell, stelt u de variabele in op een JSON-tekenreeks. Escape de aanhalingstekens: $params = '{ \"prefix\": {\"value\":\"start\"}, \"suffix\": {\"value\":\"end\"} }'.

De evaluatie van parameters volgt een opeenvolgende volgorde, wat betekent dat als een waarde meerdere keren wordt toegewezen, alleen de laatst toegewezen waarde wordt gebruikt. Als u parameters correct wilt toewijzen, is het raadzaam om het parameterbestand in eerste instantie op te geven en vervolgens de syntaxis KEY=VALUE te gebruiken om specifieke parameters selectief te overschrijven. Als u een .bicepparam parameterbestand opgeeft, kunt u dit argument slechts één keer gebruiken.

Bicep-parametersbestanden

In plaats van parameters door te geven als inlinewaarden in uw script, is het wellicht gemakkelijker om een Bicep-parametersbestand of een JSON-parameterbestand te gebruiken dat de parameterwaarden bevat. Het parameterbestand moet een lokaal bestand zijn, omdat de Azure CLI geen ondersteuning biedt voor externe parameterbestanden. Zie Parametersbestanden maken voor Bicep-implementatie voor meer informatie over parametersbestanden.

U kunt een Bicep-parametersbestand gebruiken om een Bicep-bestand te implementeren met Azure CLI versie 2.53.0 of hoger en Bicep CLI versie 0.22.X of hoger. Met de using instructie in het Bicep-parametersbestand hoeft u de --template-file schakeloptie niet op te geven bij het opgeven van een Bicep-parametersbestand voor de --parameters switch. Als u de --template-file switch opneemt, wordt de fout 'Alleen een BICEP-sjabloon is toegestaan met een BICEPPARAM-bestand'.

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:

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --parameters storage.bicepparam

JSON-parametersbestanden

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

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.bicep \
  --parameters '@storage.parameters.json'

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 de Azure CLI geen Bicep-bestanden om sjabloonspecificaties te maken. 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 JSON-sjabloon om een sjabloonspecificatie te maken.

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. Als u bijvoorbeeld een Bicep-bestand met de 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:

deploymentName='ExampleDeployment'$RANDOM

U kunt ook een datumwaarde toevoegen:

deploymentName='ExampleDeployment'$(date +"%d-%b-%Y")

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 met de naam newStorage een opslagaccount met de naam storage1 en een andere implementatie uitvoert met de naam newStorage een opslagaccount dat tegelijkertijd een opslagaccount met de naam storage2 implementeert, 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 storage1 implementeert en onmiddellijk een andere implementatie uitvoert die newStorage een opslagaccount implementeert dat is genoemd storage2 nadat de eerste implementatie is voltooid, 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 storage1 implementeert en een andere implementatie uitvoert met de naam newStorage2 die tegelijkertijd een opslagaccount met de naam storage2 implementeert, 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

Zie De structuur en syntaxis van Bicep-bestanden begrijpen voor meer informatie over het definiëren van parameters in uw bestand.