Resources implementeren met Bicep en Azure CLI

  • Artikel
  • 7 minuten om te lezen

In dit artikel wordt uitgelegd hoe u Azure CLI gebruikt met Bicep-bestanden om uw resources in Azure te implementeren. Zie Bicep overview (Bicep-overzicht) als u niet bekend bent met de concepten van het implementeren en beheren van uw Azure-oplossingen.

Vereisten

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

U hebt 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.
  • Verbinding maken naar Azure met behulp van az login. Als u meerdere Azure-abonnementen hebt, moet u mogelijk ook az account set uitvoeren.

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

Als u Azure CLI niet hebt geïnstalleerd, kunt u deze Azure Cloud Shell. Zie Bicep-bestandenimplementeren vanuit Azure Cloud Shell voor Azure Cloud Shell.

Implementatiebereik

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

  • Als u wilt implementeren in een resourcegroep, gebruikt u az deployment group create:

    az deployment group create --resource-group <resource-group-name> --template-file <path-to-bicep>

  • Als u wilt implementeren in een abonnement, gebruikt u az deployment sub create:

    az deployment sub create --location <location> --template-file <path-to-bicep>

    Zie Resourcegroepen en resources maken op abonnementsniveau voor meer informatie over implementaties op abonnementsniveau.

  • Als u wilt implementeren in een beheergroep, gebruikt u az deployment mg create:

    az deployment mg create --location <location> --template-file <path-to-bicep>

    Zie Resources maken op beheergroepniveau voor meer informatie over implementaties op beheergroepniveau.

  • Als u wilt implementeren in een tenant, gebruikt u az deployment tenant create:

    az deployment tenant create --location <location> --template-file <path-to-bicep>

    Zie Resources maken op tenantniveau voor meer informatie over implementaties op tenantniveau.

Voor elk bereik moet de gebruiker die het Bicep-bestand 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 naar een resourcegroep die niet bestaat, maakt u de resourcegroep. De naam van de resourcegroep kan alleen alfanumerieke tekens, punten, onderstrepingstekens, afbreekstreepingstekens en haakjes bevatten. Deze mag maximaal 90 tekens lang zijn. De naam mag niet eindigen op een punt.

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

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

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 bereikt, ziet u een bericht met het resultaat:

"provisioningState": "Succeeded",

Extern Bicep-bestand implementeren

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

Parameters

Als u parameterwaarden wilt doorgeven, kunt u inlineparameters of een parameterbestand gebruiken.

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 Azure CLI gebruikt met Windows opdrachtprompt (CMD) of PowerShell, geeft u de matrix door in de volgende indeling: exampleArray="['value1','value2']" .

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

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

Het is handig om een parameterwaarde uit een bestand op te geven wanneer u configuratiewaarden moet opgeven. U kunt bijvoorbeeld cloud-init-waarden voor een virtuele Linux-machine leveren.

De indeling arrayContent.json is:

[
    "value1",
    "value2"
]

Als u een object wilt doorgeven, bijvoorbeeld om tags in te stellen, gebruikt u JSON. Uw Bicep-bestand kan bijvoorbeeld een parameter bevatten zoals deze:

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

In dit geval kunt u een JSON-tekenreeks doorgeven om de parameter in te stellen, zoals wordt weergegeven in het volgende Bash-script:

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

Gebruik dubbele aanhalingstekens rond de JSON die u wilt doorgeven aan het -object.

U kunt een variabele gebruiken om de parameterwaarden op te geven. Stel in Bash de variabele in op alle parameterwaarden 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 Azure CLI gebruikt met een Windows-opdrachtprompt (CMD) of PowerShell, stelt u de variabele in op een JSON-tekenreeks. Escape de aanhalingstekens: $params = '{ \"prefix\": {\"value\":\"start\"}, \"suffix\": {\"value\":\"end\"} }' .

Parameterbestanden

In plaats van parameters als inline waarden door te geven in uw script, is het wellicht eenvoudiger een JSON-bestand te gebruiken dat de parameterwaarden bevat. Het parameterbestand moet een lokaal bestand zijn. Externe parameterbestanden worden niet ondersteund met Azure CLI. Bicep-bestand maakt gebruik van JSON-parameterbestanden.

Zie Een Resource Manager-parameterbestand maken voor meer informatie over het parameterbestand.

Als u een lokaal parameterbestand wilt doorgeven, gebruikt u om een lokaal bestand met de naam @ storage.parameters.json op te geven.

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

Voorbeeld van wijzigingen bekijken

Voordat u uw Bicep-bestand implementeert, kunt u een voorbeeld bekijken van de wijzigingen die het Bicep-bestand aan uw omgeving aan zal brengen. Gebruik de what-if-bewerking om te controleren of het Bicep-bestand de wijzigingen aan de hand heeft die u verwacht. Met Wat-als wordt ook het Bicep-bestand gevalideerd op fouten.

Sjabloonspecificaties implementeren

Momenteel biedt Azure CLI 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 op geeft voor de implementatie, wordt de naam van het Bicep-bestand gebruikt. Als u bijvoorbeeld een Bicep-bestand met de naam implementeert en geen implementatienaam main.bicep opgeeft, heeft de implementatie de naam main .

Telkens wanneer u een implementatie uitgevoerd, wordt er een vermelding toegevoegd aan de implementatiegeschiedenis van de resourcegroep met de naam van de implementatie. Als u een andere implementatie hebt uitgevoerd 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

Of voeg een datumwaarde toe.

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

Als u gelijktijdige implementaties naar dezelfde resourcegroep met dezelfde implementatienaam hebt uitgevoerd, 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 met de naam hebt uitgevoerd die een opslagaccount met de naam implementeert en tegelijkertijd een andere implementatie met de naam die een opslagaccount met de naam implementeert, implementeert u slechts één newStorage storage1 newStorage storage2 opslagaccount. Het resulterende opslagaccount heeft de naam storage2 .

Als u echter een implementatie met de naam hebt uitgevoerd die een opslagaccount met de naam implementeert en onmiddellijk nadat het is voltooid, hebt u een andere implementatie met de naam die een opslagaccount met de naam implementeert, en hebt u twee newStorage storage1 newStorage storage2 opslagaccounts. De ene heeft storage1 de naam en de andere heeft de naam storage2 . Maar u hebt slechts één vermelding in de implementatiegeschiedenis.

Wanneer u voor elke implementatie een unieke naam opgeeft, kunt u deze gelijktijdig zonder conflicten uitvoeren. Als u een implementatie met de naam hebt uitgevoerd die een opslagaccount met de naam implementeert en tegelijkertijd een andere implementatie met de naam die een opslagaccount met de naam implementeert, hebt u twee opslagaccounts en twee vermeldingen in de newStorage1 storage1 newStorage2 storage2 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 Inzicht in de structuur en syntaxis van Bicep-bestanden voor meer inzicht in het definiëren van parameters in uw bestand.