Ontwikkelomgeving configureren voor implementatiescripts in ARM-sjablonen

Artikel
20/03/2024

Meer informatie over het maken van een ontwikkelomgeving voor het ontwikkelen en testen van implementatiescripts voor ARM-sjablonen met een installatiekopieën van een implementatiescript. U kunt een Azure-containerinstantie maken of Docker gebruiken. Beide opties worden behandeld in dit artikel.

Vereisten

Azure PowerShell-container

Als u geen Azure PowerShell-implementatiescript hebt, kunt u een hello.ps1-bestand maken met behulp van de volgende inhoud:

PowerShell

param([string] $name)
$output = 'Hello {0}' -f $name
Write-Output $output
$DeploymentScriptOutputs = @{}
$DeploymentScriptOutputs['text'] = $output

Azure CLI-container

Voor een Azure CLI-containerinstallatiekopieën kunt u een hello.sh-bestand maken met behulp van de volgende inhoud:

Bash

FIRSTNAME=$1
LASTNAME=$2
OUTPUT="{\"name\":{\"displayName\":\"$FIRSTNAME $LASTNAME\",\"firstName\":\"$FIRSTNAME\",\"lastName\":\"$LASTNAME\"}}"
echo -n "Hello "
echo $OUTPUT | jq -r '.name.displayName'

Notitie

Wanneer u een Azure CLI-implementatiescript uitvoert, slaat een omgevingsvariabele met de naam AZ_SCRIPTS_OUTPUT_PATH de locatie van het scriptuitvoerbestand op. De omgevingsvariabele is niet beschikbaar in de container voor de ontwikkelomgeving. Zie Werken met uitvoer van CLI voor meer informatie over het werken met Azure CLI-uitvoer.

Azure PowerShell-containerinstantie gebruiken

Als u uw scripts op uw computer wilt maken, moet u een opslagaccount maken en het opslagaccount koppelen aan de containerinstantie. U kunt uw script dus uploaden naar het opslagaccount en het script uitvoeren op de containerinstantie.

Notitie

Het opslagaccount dat u maakt om uw script te testen, is niet hetzelfde opslagaccount dat door de implementatiescriptservice wordt gebruikt om het script uit te voeren. De implementatiescriptservice maakt een unieke naam als een bestandsshare voor elke uitvoering.

Een Azure PowerShell-containerinstantie maken

Met de volgende Azure Resource Manager-sjabloon (ARM-sjabloon) maakt u een containerinstantie en een bestandsshare en koppelt u de bestandsshare vervolgens aan de containerinstallatiekopieën.

JSON

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "projectName": {
      "type": "string",
      "metadata": {
        "description": "Specify a project name that is used for generating resource names."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Specify the resource location."
      }
    },
    "containerImage": {
      "type": "string",
      "defaultValue": "mcr.microsoft.com/azuredeploymentscripts-powershell:az9.7",
      "metadata": {
        "description": "Specify the container image."
      }
    },
    "mountPath": {
      "type": "string",
      "defaultValue": "/mnt/azscripts/azscriptinput",
      "metadata": {
        "description": "Specify the mount path."
      }
    }
  },
  "variables": {
    "storageAccountName": "[toLower(format('{0}store', parameters('projectName')))]",
    "fileShareName": "[format('{0}share', parameters('projectName'))]",
    "containerGroupName": "[format('{0}cg', parameters('projectName'))]",
    "containerName": "[format('{0}container', parameters('projectName'))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2023-01-01",
      "name": "[variables('storageAccountName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {
        "accessTier": "Hot"
      }
    },
    {
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "apiVersion": "2023-01-01",
      "name": "[format('{0}/default/{1}', variables('storageAccountName'), variables('fileShareName'))]",
      "dependsOn": [
        "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
      ]
    },
    {
      "type": "Microsoft.ContainerInstance/containerGroups",
      "apiVersion": "2023-05-01",
      "name": "[variables('containerGroupName')]",
      "location": "[parameters('location')]",
      "properties": {
        "containers": [
          {
            "name": "[variables('containerName')]",
            "properties": {
              "image": "[parameters('containerImage')]",
              "resources": {
                "requests": {
                  "cpu": 1,
                  "memoryInGB": "[json('1.5')]"
                }
              },
              "ports": [
                {
                  "protocol": "TCP",
                  "port": 80
                }
              ],
              "volumeMounts": [
                {
                  "name": "filesharevolume",
                  "mountPath": "[parameters('mountPath')]"
                }
              ],
              "command": [
                "/bin/sh",
                "-c",
                "pwsh -c 'Start-Sleep -Seconds 1800'"
              ]
            }
          }
        ],
        "osType": "Linux",
        "volumes": [
          {
            "name": "filesharevolume",
            "azureFile": {
              "readOnly": false,
              "shareName": "[variables('fileShareName')]",
              "storageAccountName": "[variables('storageAccountName')]",
              "storageAccountKey": "[listKeys(resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName')), '2023-01-01').keys[0].value]"
            }
          }
        ]
      },
      "dependsOn": [
        "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
      ]
    }
  ]
}

De standaardwaarde voor het koppelpad is /mnt/azscripts/azscriptinput. Dit is het pad in de containerinstantie waar het is gekoppeld aan de bestandsshare.

De standaardinstallatiekopieën van de container die in de sjabloon zijn opgegeven, zijn mcr.microsoft.com/azuredeploymentscripts-powershell:az9.7. Bekijk een lijst met alle ondersteunde Azure PowerShell-versies.

De sjabloon onderbreekt de containerinstantie na 1800 seconden. U hebt 30 minuten voordat de containerinstantie de status Beëindigd krijgt en de sessie wordt beëindigd.

De sjabloon implementeren:

Azure PowerShell

$projectName = Read-Host -Prompt "Enter a project name that is used to generate resource names"
$location = Read-Host -Prompt "Enter the location (i.e. centralus)"
$templateFile = Read-Host -Prompt "Enter the template file path and file name"
$resourceGroupName = "${projectName}rg"

New-AzResourceGroup -Location $location -name $resourceGroupName
New-AzResourceGroupDeployment -resourceGroupName $resourceGroupName -TemplateFile $templatefile -projectName $projectName

Het implementatiescript uploaden

Upload uw implementatiescript naar het opslagaccount. Hier volgt een voorbeeld van een PowerShell-script:

Azure PowerShell

$projectName = Read-Host -Prompt "Enter the same project name that you used earlier"
$fileName = Read-Host -Prompt "Enter the deployment script file name with the path"

$resourceGroupName = "${projectName}rg"
$storageAccountName = "${projectName}store"
$fileShareName = "${projectName}share"

$context = (Get-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName).Context
Set-AzStorageFileContent -Context $context -ShareName $fileShareName -Source $fileName -Force

U kunt het bestand ook uploaden met behulp van Azure Portal of de Azure CLI.

Het implementatiescript testen

Open in Azure Portal de resourcegroep waarin u de containerinstantie en het opslagaccount hebt geïmplementeerd.
Open de containergroep. De standaardnaam van de containergroep is de projectnaam die is toegevoegd aan cg. De containerinstantie heeft de status Actief .
Selecteer Containers in het resourcemenu. De naam van het containerexemplaren is de projectnaam die is toegevoegd aan de container.
Selecteer Verbinding maken en selecteer vervolgens Verbinding maken. Als u geen verbinding kunt maken met de containerinstantie, start u de containergroep opnieuw en probeert u het opnieuw.
Voer in het consolevenster de volgende opdrachten uit:

Console
```
cd /mnt/azscripts/azscriptinput
ls
pwsh ./hello.ps1 "John Dole"
```
De uitvoer is Hello John Dole.

Een Azure CLI-containerinstantie gebruiken

Als u uw scripts op uw computer wilt maken, maakt u een opslagaccount en koppelt u het opslagaccount aan de containerinstantie. Vervolgens kunt u uw script uploaden naar het opslagaccount en het script uitvoeren op de containerinstantie.

Notitie

Een Azure CLI-containerinstantie maken

Met de volgende ARM-sjabloon maakt u een containerinstantie en een bestandsshare en koppelt u de bestandsshare vervolgens aan de containerinstallatiekopieën:

JSON

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "projectName": {
      "type": "string",
      "metadata": {
        "description": "Specify a project name that is used for generating resource names."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Specify the resource location."
      }
    },
    "containerImage": {
      "type": "string",
      "defaultValue": "mcr.microsoft.com/azure-cli:2.9.1",
      "metadata": {
        "description": "Specify the container image."
      }
    },
    "mountPath": {
      "type": "string",
      "defaultValue": "/mnt/azscripts/azscriptinput",
      "metadata": {
        "description": "Specify the mount path."
      }
    }
  },
  "variables": {
    "storageAccountName": "[toLower(format('{0}store', parameters('projectName')))]",
    "fileShareName": "[format('{0}share', parameters('projectName'))]",
    "containerGroupName": "[format('{0}cg', parameters('projectName'))]",
    "containerName": "[format('{0}container', parameters('projectName'))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[variables('storageAccountName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {
        "accessTier": "Hot"
      }
    },
    {
      "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
      "apiVersion": "2022-09-01",
      "name": "[format('{0}/default/{1}', variables('storageAccountName'), variables('fileShareName'))]",
      "dependsOn": [
        "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
      ]
    },
    {
      "type": "Microsoft.ContainerInstance/containerGroups",
      "apiVersion": "2023-05-01",
      "name": "[variables('containerGroupName')]",
      "location": "[parameters('location')]",
      "properties": {
        "containers": [
          {
            "name": "[variables('containerName')]",
            "properties": {
              "image": "[parameters('containerImage')]",
              "resources": {
                "requests": {
                  "cpu": 1,
                  "memoryInGB": "[json('1.5')]"
                }
              },
              "ports": [
                {
                  "protocol": "TCP",
                  "port": 80
                }
              ],
              "volumeMounts": [
                {
                  "name": "filesharevolume",
                  "mountPath": "[parameters('mountPath')]"
                }
              ],
              "command": [
                "/bin/bash",
                "-c",
                "echo hello; sleep 1800"
              ]
            }
          }
        ],
        "osType": "Linux",
        "volumes": [
          {
            "name": "filesharevolume",
            "azureFile": {
              "readOnly": false,
              "shareName": "[variables('fileShareName')]",
              "storageAccountName": "[variables('storageAccountName')]",
              "storageAccountKey": "[listKeys(resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName')), '2022-09-01').keys[0].value]"
            }
          }
        ]
      },
      "dependsOn": [
        "storageAccount"
      ]
    }
  ]
}

De standaardwaarde voor het koppelpad is /mnt/azscripts/azscriptinput. Dit is het pad in de containerinstantie waar het is gekoppeld aan de bestandsshare.

De standaardinstallatiekopieën van de container die in de sjabloon zijn opgegeven, zijn mcr.microsoft.com/azure-cli:2.9.1. Bekijk een lijst met ondersteunde Azure CLI-versies.

Belangrijk

Het implementatiescript maakt gebruik van de beschikbare CLI-installatiekopieën van Microsoft Container Registry (MCR). Het duurt ongeveer één maand om een CLI-installatiekopieën te certificeren voor een implementatiescript. Gebruik niet de CLI-versies die binnen 30 dagen zijn uitgebracht. Raadpleeg de releaseopmerkingen van Azure CLI om de releasedatums voor de installatiekopieën te vinden. Als u een niet-ondersteunde versie gebruikt, worden in het foutbericht de ondersteunde versies vermeld.

De sjabloon onderbreekt de containerinstantie na 1800 seconden. U hebt 30 minuten voordat de containerinstantie de terminalstatus krijgt en de sessie wordt beëindigd.

De sjabloon implementeren:

Azure PowerShell

$projectName = Read-Host -Prompt "Enter a project name that is used to generate resource names"
$location = Read-Host -Prompt "Enter the location (i.e. centralus)"
$templateFile = Read-Host -Prompt "Enter the template file path and file name"
$resourceGroupName = "${projectName}rg"

New-AzResourceGroup -Location $location -name $resourceGroupName
New-AzResourceGroupDeployment -resourceGroupName $resourceGroupName -TemplateFile $templatefile -projectName $projectName

Het implementatiescript uploaden

Upload uw implementatiescript naar het opslagaccount. Hier volgt een PowerShell-voorbeeld:

Azure PowerShell

$projectName = Read-Host -Prompt "Enter the same project name that you used earlier"
$fileName = Read-Host -Prompt "Enter the deployment script file name with the path"

$resourceGroupName = "${projectName}rg"
$storageAccountName = "${projectName}store"
$fileShareName = "${projectName}share"

$context = (Get-AzStorageAccount -ResourceGroupName $resourceGroupName -Name $storageAccountName).Context
Set-AzStorageFileContent -Context $context -ShareName $fileShareName -Source $fileName -Force

U kunt het bestand ook uploaden met behulp van Azure Portal of de Azure CLI.

Het implementatiescript testen

Open in Azure Portal de resourcegroep waarin u de containerinstantie en het opslagaccount hebt geïmplementeerd.
Open de containergroep. De standaardnaam van de containergroep is de projectnaam die is toegevoegd aan cg. De containerinstantie wordt weergegeven in de status Actief .
Selecteer Containers in het resourcemenu. De naam van het containerexemplaren is de projectnaam die is toegevoegd aan de container.
Selecteer Verbinding maken en selecteer vervolgens Verbinding maken. Als u geen verbinding kunt maken met de containerinstantie, start u de containergroep opnieuw en probeert u het opnieuw.
Voer in het consolevenster de volgende opdrachten uit:

Console
```
cd /mnt/azscripts/azscriptinput
ls
./hello.sh John Dole
```
De uitvoer is Hello John Dole.

Docker gebruiken

U kunt een vooraf geconfigureerde Docker-containerinstallatiekopieën gebruiken als uw ontwikkelomgeving voor implementatiescripts. Zie Docker downloaden om Docker te installeren. U moet ook het delen van bestanden configureren om de map te koppelen, die de implementatiescripts bevat in de Docker-container.

Haal de containerinstallatiekopie van het implementatiescript op de lokale computer:

command
```
docker pull mcr.microsoft.com/azuredeploymentscripts-powershell:az4.3
```
In het voorbeeld wordt versie PowerShell 4.3.0 gebruikt.

Een CLI-installatiekopie ophalen uit een MCR:

command
```
docker pull mcr.microsoft.com/azure-cli:2.0.80
```
In dit voorbeeld wordt versie CLI 2.0.80 gebruikt. Implementatiescript maakt gebruik van de standaard-CLI-containerinstallatiekopieën die hier worden gevonden.
Voer de Docker-installatiekopieën lokaal uit.

command
```
docker run -v <host drive letter>:/<host directory name>:/data -it mcr.microsoft.com/azuredeploymentscripts-powershell:az4.3
```
Vervang de letter> van het hoststuurprogramma en <de hostmapnaam> door een bestaande map op het gedeelde station.< De map wordt toegewezen aan de map /data in de container. Bijvoorbeeld om D:\docker toe te wijzen:

command
```
docker run -v d:/docker:/data -it mcr.microsoft.com/azuredeploymentscripts-powershell:az4.3
```
-het betekent dat de containerinstallatiekopieën actief blijven.

Een CLI-voorbeeld:

command
```
docker run -v d:/docker:/data -it mcr.microsoft.com/azure-cli:2.0.80
```
In de volgende schermopname ziet u hoe u een PowerShell-script uitvoert, aangezien u een helloworld.ps1-bestand in het gedeelde station hebt.

Nadat het script is getest, kunt u het gebruiken als een implementatiescript in uw sjablonen.

Volgende stappen

In dit artikel hebt u geleerd hoe u implementatiescripts gebruikt. Een zelfstudie voor een implementatiescript doorlopen:

Zelfstudie: Implementatiescripts gebruiken in ARM-sjablonen

Aanvullende resources

Documentatie

Implementatiescripts gebruiken in sjablonen - Azure Resource Manager

Implementatiescripts gebruiken in Azure Resource Manager-sjablonen.
Sjabloonimplementatiescripts gebruiken - Azure Resource Manager

Meer informatie over het gebruik van implementatiescripts in ARM-sjablonen (Azure Resource Manager).
Microsoft.Resources/deploymentScripts - Bicep, ARM template & Terraform AzAPI reference

De syntaxis en eigenschappen van Azure Microsoft.Resources/deploymentScripts die moeten worden gebruikt in Azure Resource Manager-sjablonen voor het implementeren van de resource. Nieuwste API-versie
Test-toolkit voor ARM-sjablonen - Azure Resource Manager

Hierin wordt beschreven hoe u de TEST-toolkit voor Azure Resource Manager-sjabloon (ARM-sjabloon) uitvoert op uw sjabloon. Met de toolkit kunt u zien of u aanbevolen procedures hebt geïmplementeerd.
SjabSjabloonspecificaties maken en implementeren maken en implementeren - Azure Resource Manager

Hierin wordt beschreven hoe u sjabloonspecificaties maakt en deelt met andere gebruikers in uw organisatie.
Sjabloonstructuur en syntaxis - Azure Resource Manager

Beschrijft de structuur en eigenschappen van Azure Resource Manager-sjablonen (ARM-sjablonen) met behulp van declaratieve JSON-syntaxis.
Sjabloonsyntaxis en expressies - Azure Resource Manager

Beschrijft de declaratieve JSON-syntaxis voor Azure Resource Manager-sjablonen (ARM-sjablonen).

Training

Module

Bicep- en ARM-sjablonen uitbreiden met behulp van implementatiescripts - Training

Leer hoe u aangepaste stappen toevoegt aan uw ARM-sjablonen (Azure Resource Manager) en Bicep-bestanden met behulp van implementatiescripts.

Certificering

Microsoft Certified: Azure Developer Associate (Microsoft Gecertificeerd: Azure Ontwikkelaar Associate) - Certifications

Bouw end-to-end-oplossingen in Microsoft Azure om Azure Functions te maken, web-apps te implementeren en te beheren, oplossingen te ontwikkelen die gebruikmaken van Azure Storage en meer.

Share via

Ontwikkelomgeving configureren voor implementatiescripts in ARM-sjablonen

Vereisten

Azure PowerShell-container

Azure CLI-container

Azure PowerShell-containerinstantie gebruiken

Een Azure PowerShell-containerinstantie maken

Het implementatiescript uploaden

Het implementatiescript testen

Een Azure CLI-containerinstantie gebruiken

Een Azure CLI-containerinstantie maken

Het implementatiescript uploaden

Het implementatiescript testen

Docker gebruiken

Volgende stappen

Feedback

Aanvullende resources