Arm-implementatie Azure Resource Manager sjablonen (ARM) gebruiken met Azure CLI

Artikel
09/24/2021
9 minuten om te lezen

In dit artikel wordt uitgelegd hoe u Azure CLI gebruikt met Azure Resource Manager-sjablonen (ARM-sjablonen) om uw resources in Azure te implementeren. Zie Overzicht van sjabloonimplementatie als u niet bekend bent met de concepten van het implementeren en beheren van uw Azure-oplossingen.

De implementatieopdrachten zijn gewijzigd in Azure CLI versie 2.2.0. Voor de voorbeelden in dit artikel is Azure CLI versie 2.20.0 of hoger vereist.

Als u dit voorbeeld wilt uitvoeren, installeert u de nieuwste versie van de Azure CLI. Voer eerst az login uit om een verbinding op te zetten met Azure.

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 ARM-sjablonen implementeren vanuit Azure Cloud Shell voor meer Azure Cloud Shell.

Implementatiebereik

U kunt uw Azure-implementatiesjabloon 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-template>

Als u wilt implementeren in een abonnement, gebruikt u az deployment sub create:
```
az deployment sub create --location <location> --template-file <path-to-template>
```
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-template>
```
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-template>
```
Zie Resources maken op tenantniveau voor meer informatie over implementaties op tenantniveau.

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

Een lokale sjabloon implementeren

U kunt een ARM-sjabloon implementeren vanaf uw lokale computer of een sjabloon die extern is opgeslagen. In deze sectie wordt beschreven hoe u een lokale sjabloon 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 lokale sjabloon 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-template> \
  --parameters storageAccountType=Standard_GRS

Het kan enkele minuten duren voordat de Azure-implementatiesjabloon is voltooid. Wanneer dit is bereikt, ziet u een bericht met het resultaat:

"provisioningState": "Succeeded",

Externe sjabloon implementeren

In plaats van ARM-sjablonen op uw lokale computer op te slaan, kunt u deze het liefst opslaan op een externe locatie. U kunt sjablonen opslaan in een opslagplaats voor broncodebeheer (zoals GitHub). U kunt de sjablonen ook opslaan in een Azure-opslagaccount voor gedeelde toegang in uw organisatie.

Notitie

Voor het implementeren van een sjabloon of een verwijzing naar een gekoppelde sjabloon die is opgeslagen in een persoonlijke GitHub-opslag plaats, raadpleegt u een aangepaste oplossing die wordt beschreven in een MVP-blog. U kunt een Azure- functie instellen als een proxy om de URL te maken die nodig is voor toegang tot een sjabloon bestand in een persoonlijke github-opslag plaats.

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

Als u een externe sjabloon wilt implementeren, gebruikt u de template-uri-parameter.

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-uri "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json" \
  --parameters storageAccountType=Standard_GRS

In het voorgaande voorbeeld is een openbaar toegankelijke URI voor de sjabloon vereist. Dit werkt voor de meeste scenario's omdat uw sjabloon geen gevoelige gegevens mag bevatten. Als u gevoelige gegevens moet opgeven (zoals een beheerderswachtwoord), geeft u die waarde door als een beveiligde parameter. Als u echter de toegang tot de sjabloon wilt beheren, kunt u sjabloonspecificaties gebruiken.

Als u externe gekoppelde sjablonen met een relatief pad wilt implementeren die zijn opgeslagen in een opslagaccount, gebruikt u query-string om het SAS-token op te geven:

az deployment group create \
  --name linkedTemplateWithRelativePath \
  --resource-group myResourceGroup \
  --template-uri "https://stage20210126.blob.core.windows.net/template-staging/mainTemplate.json" \
  --query-string $sasToken

Zie Relatief pad gebruiken voor gekoppelde sjablonen voor meer informatie.

Naam van Azure-implementatiesjabloon

Wanneer u een ARM-sjabloon implementeert, kunt u de Azure-implementatiesjabloon 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 sjabloonbestand gebruikt. Als u bijvoorbeeld een sjabloon met de naam azuredeploy.json implementeert en geen implementatienaam opgeeft, heeft de implementatie de naam azuredeploy .

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.

Sjabloonspecificatie implementeren

In plaats van een lokale of externe sjabloon te implementeren, kunt u een sjabloonspecificatie maken. De sjabloonspecificatie is een resource in uw Azure-abonnement die een ARM-sjabloon bevat. Zo kunt u de sjabloon eenvoudig veilig delen met gebruikers in uw organisatie. U gebruikt op rollen gebaseerd toegangsbeheer van Azure (Azure RBAC) om toegang te verlenen tot de sjabloonspecificatie. Deze functie is momenteel beschikbaar als preview-versie.

De volgende voorbeelden laten zien hoe u een sjabloonspecificatie maakt en implementeert.

Maak eerst de sjabloonspecificatie door de ARM-sjabloon op te geven.

az ts create \
  --name storageSpec \
  --version "1.0" \
  --resource-group templateSpecRG \
  --location "westus2" \
  --template-file "./mainTemplate.json"

Haal vervolgens de id voor sjabloonspecificatie op en implementeer deze.

id = $(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0" --query "id")

az deployment group create \
  --resource-group demoRG \
  --template-spec $id

Zie sjabloonspecificaties voor Azure Resource Manager meer informatie.

Voorbeeld van wijzigingen bekijken

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

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 sjabloon in een Bash-shell, gebruikt u:

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-template> \
  --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-template> \
  --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 bijvoorbeeld een -object wilt doorgeven om tags in te stellen, gebruikt u JSON. Uw sjabloon 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 $templateFile \
--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-template> \
  --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.

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.json \
  --parameters '@storage.parameters.json'

Uitgebreide JSON-indeling verwerken

Als u een sjabloon met meerdere regelreeksen of opmerkingen wilt implementeren met behulp van Azure CLI met versie 2.3.0 of ouder, moet u de --handle-extended-json-format switch gebruiken. Bijvoorbeeld:

{
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2018-10-01",
  "name": "[variables('vmName')]", // to customize name, change it in variables
  "location": "[
    parameters('location')
    ]", //defaults to resource group location
  /*
    storage account and network interface
    must be deployed first
  */
  "dependsOn": [
    "[resourceId('Microsoft.Storage/storageAccounts/', variables('storageAccountName'))]",
    "[resourceId('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
  ],

Volgende stappen

Zie Terugdraaien bij fout naar geslaagde implementatie als u wilt terugdraaien naar een geslaagde implementatie wanneer er een foutmelding wordt weergegeven.
Zie implementatiemodi voor meer informatie over het afhandelen van resources die in de resourcegroep bestaan, maar die niet Azure Resource Manager zijn gedefinieerd in desjabloon.
Zie Inzicht in de structuur en syntaxis van ARM-sjablonen voor meer informatie over het definiëren van parameters in uw sjabloon.
Zie Veelvoorkomende implementatiefouten in Azure oplossen met Azure Resource Manager voor tips over het oplossen van veelvoorkomende implementatiefouten.