Använda arm Azure Resource Manager distributionsmallar med Azure CLI

  • Artikel
  • 8 minuter för att läsa

Den här artikeln beskriver hur du använder Azure CLI med Azure Resource Manager -mallar (ARM-mallar) för att distribuera dina resurser till Azure. Om du inte är bekant med begreppen för att distribuera och hantera azure-lösningar kan du gå till malldistributionsöversikten.

Distributionskommandona har ändrats i Azure CLI version 2.2.0. Exemplen i den här artikeln kräver Azure CLI version 2.20.0 eller senare.

Om du vill köra det här exemplet installerar du den senaste versionen av Azure CLI. Börja genom att köra az login för att upprätta en anslutning med Azure.

Exempel för Azure CLI skrivs för bash gränssnittet. Om du vill köra det här exemplet i Windows PowerShell eller kommando tolken kan du behöva ändra element i skriptet.

Om du inte har Installerat Azure CLI kan du använda Azure Cloud Shell. Mer information finns i Distribuera ARM-mallar från Azure Cloud Shell.

Distributionsomfång

Du kan rikta din Azure-distributionsmall till en resursgrupp, prenumeration, hanteringsgrupp eller klientorganisation. Beroende på distributionens omfattning använder du olika kommandon.

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

Distribuera en lokal mall

Du kan distribuera en ARM-mall från din lokala dator eller en som lagras externt. I det här avsnittet beskrivs hur du distribuerar en lokal mall.

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

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

Om du vill distribuera en lokal mall använder du --template-file parametern i distributionskommandot. I följande exempel visas också hur du anger ett parametervärde.

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

Det kan ta några minuter att slutföra Distributionsmallen för Azure. När det är klart visas ett meddelande som innehåller resultatet:

"provisioningState": "Succeeded",

Distribuera fjärrmall

I stället för att lagra ARM-mallar på den lokala datorn kanske du föredrar att lagra dem på en extern plats. Du kan lagra mallar på en lagringsplats för versionskontroll (till exempel GitHub). Eller så kan du lagra dem i ett Azure Storage-konto för delad åtkomst i din organisation.

Anteckning

Om du vill distribuera en mall eller referera till en länkad mall som är lagrad i en privat GitHub lagrings platsen, se en anpassad lösning som dokumenterats i en MVP-blogg. Du kan konfigurera en Azure-funktion som proxy för att skapa den URL som behövs för att få åtkomst till en mallfil i en privat GitHub-lagrings platsen.

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

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

Om du vill distribuera en extern mall använder du parametern template-uri.

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

Föregående exempel kräver en offentligt tillgänglig URI för mallen, som fungerar för de flesta scenarier eftersom mallen inte ska innehålla känsliga data. Om du behöver ange känsliga data (till exempel ett administratörslösenord) skickar du det värdet som en säker parameter. Men om du vill hantera åtkomsten till mallen bör du överväga att använda mallspecifikt .

Om du vill distribuera fjärranslutna länkade mallar med relativ sökväg som lagras i ett lagringskonto använder du query-string för att ange SAS-token:

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

Mer information finns i Använda relativ sökväg för länkade mallar.

Mallnamn för Azure-distribution

När du distribuerar en ARM-mall kan du ge Azure-distributionsmallen ett namn. Det här namnet kan hjälpa dig att hämta distributionen från distributionshistoriken. Om du inte anger ett namn för distributionen används namnet på mallfilen. Om du till exempel distribuerar en mall med namnet azuredeploy.json och inte anger ett distributionsnamn får distributionen namnet azuredeploy .

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.

deploymentName='ExampleDeployment'$RANDOM

Du kan också lägga till ett datumvärde.

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

Om du kör samtidiga distributioner till samma resursgrupp med samma distributionsnamn slutförs bara 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 som distribuerar ett lagringskonto med namnet och samtidigt kör en annan distribution med namnet som distribuerar ett lagringskonto med namnet , distribuerar du bara ett newStorage storage1 newStorage storage2 lagringskonto. Det resulterande lagringskontot heter storage2 .

Men om du kör en distribution med namnet som distribuerar ett lagringskonto med namnet och omedelbart efter att den är klar kör du en annan distribution med namnet som distribuerar ett lagringskonto med namnet , så har du newStorage storage1 två newStorage storage2 lagringskonton. Den ena storage1 heter och 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 som distribuerar ett lagringskonto med namnet och samtidigt kör en annan distribution med namnet som distribuerar ett lagringskonto med namnet , har du två lagringskonton och två poster i newStorage1 storage1 newStorage2 storage2 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.

Distribuera mallspecifikt

I stället för att distribuera en lokal mall eller en fjärrmall kan du skapa en mallspecifikt. Mallspecifikationen är en resurs i din Azure-prenumeration som innehåller en ARM-mall. Det gör det enkelt att på ett säkert sätt dela mallen med användare i din organisation. Du använder rollbaserad åtkomstkontroll i Azure (Azure RBAC) för att bevilja åtkomst till mallspecifikationen. Den här funktionen är för närvarande i förhandsversion.

I följande exempel visas hur du skapar och distribuerar en mallspecifikt.

Skapa först mallspecifikationen genom att tillhandahålla ARM-mallen.

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

Hämta sedan ID:t för mallspecifikationen och distribuera det.

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

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

Mer information finns i Azure Resource Manager specifikationerför .

Förhandsgranska ändringar

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

Parametrar

Om du vill skicka parametervärden kan du använda antingen infogade parametrar eller en parameterfil.

Infogade parametrar

Om du vill skicka infogade parametrar anger du värdena i parameters . Om du till exempel vill skicka en sträng och matris till en mall i ett Bash-gränssnitt använder du:

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

Om du använder Azure CLI med Windows kommandotolk (CMD) eller PowerShell skickar du matrisen i formatet: exampleArray="['value1','value2']" .

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

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

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

Formatet arrayContent.json är:

[
    "value1",
    "value2"
]

Om du till exempel vill skicka in ett objekt för att ange taggar använder du JSON. Mallen kan till exempel innehålla en parameter som den här:

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

I det här fallet kan du skicka in en JSON-sträng för att ange parametern enligt följande Bash-skript:

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

Använd dubbla citattecken runt den JSON som du vill skicka till objektet.

Du kan använda en variabel som innehåller parametervärdena. I Bash anger du variabeln till alla parametervärden och lägger till den i distributionskommandot.

params="prefix=start suffix=end"

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

Men om du använder Azure CLI med Windows kommandotolk (CMD) eller PowerShell anger du variabeln till en JSON-sträng. Undvik citattecknen: $params = '{ \"prefix\": {\"value\":\"start\"}, \"suffix\": {\"value\":\"end\"} }' .

Parameterfiler

I stället för att skicka parametrar som infogade värden i skriptet, kan det vara lättare att använda en JSON-fil som innehåller parametervärdena. Parameterfilen måste vara en lokal fil. Externa parameterfiler stöds inte med Azure CLI.

Mer information om parameterfilen finns i Skapa en parameterfil för Resource Manager.

Om du vill skicka en lokal parameterfil använder @ du för att ange en lokal fil med namnet storage.parameters.json.

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

Hantera utökat JSON-format

Om du vill distribuera en mall med flerradssträngar eller kommentarer med hjälp av Azure CLI med version 2.3.0 eller äldre måste du använda --handle-extended-json-format växeln . Exempel:

{
  "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'))]"
  ],

Nästa steg