Konfigurieren der Entwicklungsumgebung für Bereitstellungsskripts in Bicep-Dateien

Hier erfahren Sie, wie Sie eine Bereitstellungsumgebung für das Erstellen und Testen von Bereitstellungsskripts mit einem Bereitstellungsskriptimage erstellen. Sie können entweder eine Azure-Containerinstanz erstellen oder Docker verwenden. Beide Optionen werden in diesem Artikel beschrieben.

Voraussetzungen

Azure PowerShell-Container

Wenn Sie über kein Azure PowerShell-Bereitstellungsskript verfügen, können Sie eine Datei hello.ps1 mit dem folgenden Inhalt erstellen:

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

param([string] $name, [string] $subscription)
$output = 'Hello {0}' -f $name
#Write-Output $output

Connect-AzAccount -UseDeviceAuthentication
Set-AzContext -subscription $subscription

$kv = Get-AzKeyVault
#Write-Output $kv

$DeploymentScriptOutputs = @{}
$DeploymentScriptOutputs['greeting'] = $output
$DeploymentScriptOutputs['kv'] = $kv.resourceId
Write-Output $DeploymentScriptOutputs

In einem Azure PowerShell-Bereitstellungsskript wird die Variable $DeploymentScriptOutputs verwendet, um die Ausgabewerte zu speichern. Weitere Informationen zum Arbeiten mit Azure PowerShell-Ausgaben finden Sie unter Arbeiten mit Ausgaben.

Azure CLI-Container

Wenn Sie ein Azure CLI-Containerimage verwenden möchten, können Sie eine Datei hello.sh mit dem folgenden Inhalt erstellen:

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

Wenn Sie ein Azure CLI-Bereitstellungsskript ausführen, wird der Speicherort der Skriptausgabedatei in einer Umgebungsvariablen mit dem Namen AZ_SCRIPTS_OUTPUT_PATH gespeichert. Die Umgebungsvariable ist im Container der Entwicklungsumgebung nicht verfügbar. Weitere Informationen zum Arbeiten mit Azure CLI-Ausgaben finden Sie unter Arbeiten mit Ausgaben von CLI-Skripts.

Verwenden einer Azure PowerShell-Containerinstanz

Sie müssen ein Speicherkonto erstellen und dieses in die Containerinstanz einbinden, um Azure PowerShell-Skripte auf Ihrem Computer zu erstellen. Auf diese Weise können Sie Ihr Skript in das Speicherkonto hochladen und in der Containerinstanz ausführen. Das Speicherkonto, das Sie zum Testen Ihres Skripts erstellen, ist nicht das gleiche Speicherkonto, das der Bereitstellungsskriptdienst zum Ausführen des Skripts verwendet. Der Bereitstellungsskriptdienst erstellt bei jeder Ausführung einen eindeutigen Namen als Dateifreigabe.

Erstellen einer Azure PowerShell-Containerinstanz

Mit der folgenden Bicep-Datei werden eine Containerinstanz und eine Dateifreigabe erstellt. Letztere wird dann in das Containerimage eingebunden.

@description('Specify a project name that is used for generating resource names.')
param projectName string

@description('Specify the resource location.')
param location string = resourceGroup().location

@description('Specify the container image.')
param containerImage string = 'mcr.microsoft.com/azuredeploymentscripts-powershell:az9.7'

@description('Specify the mount path.')
param mountPath string = '/mnt/azscripts/azscriptinput'

var storageAccountName = toLower('${projectName}store')
var fileShareName = '${projectName}share'
var containerGroupName = '${projectName}cg'
var containerName = '${projectName}container'

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-01-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
  }
}

resource fileShare 'Microsoft.Storage/storageAccounts/fileServices/shares@2023-01-01' = {
  name: '${storageAccountName}/default/${fileShareName}'
  dependsOn: [
    storageAccount
  ]
}

resource containerGroup 'Microsoft.ContainerInstance/containerGroups@2023-05-01' = {
  name: containerGroupName
  location: location
  properties: {
    containers: [
      {
        name: containerName
        properties: {
          image: containerImage
          resources: {
            requests: {
              cpu: 1
              memoryInGB: json('1.5')
            }
          }
          ports: [
            {
              protocol: 'TCP'
              port: 80
            }
          ]
          volumeMounts: [
            {
              name: 'filesharevolume'
              mountPath: mountPath
            }
          ]
          command: [
            '/bin/sh'
            '-c'
            'pwsh -c \'Start-Sleep -Seconds 1800\''
          ]
        }
      }
    ]
    osType: 'Linux'
    volumes: [
      {
        name: 'filesharevolume'
        azureFile: {
          readOnly: false
          shareName: fileShareName
          storageAccountName: storageAccountName
          storageAccountKey: storageAccount.listKeys().keys[0].value
        }
      }
    ]
  }
}

Der Standardwert für den Einbindungspfad lautet /mnt/azscripts/azscriptinput. Dies ist der Pfad in der Containerinstanz, unter dem sie in die Dateifreigabe eingebunden wird.

Das in der Bicep-Datei angegebene Standardcontainerimage ist mcr.microsoft.com/azuredeploymentscripts-powershell:az9.7. Eine Liste aller unterstützter Azure PowerShell-Versionen finden Sie hier.

Die Bicep-Datei hält die Containerinstanz nach 1.800 Sekunden an. Sie haben 30 Minuten Zeit, bis die Containerinstanz in einen Beendigungsstatus wechselt und die Sitzung beendet wird.

Führen Sie das folgende Skript, um die Bicep-Datei bereitzustellen:

$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 Bicep file path and file name"
$resourceGroupName = "${projectName}rg"

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

Hochladen des Bereitstellungsskripts

Laden Sie Ihr Bereitstellungsskript in das Speicherkonto hoch. Nachfolgend sehen Sie ein Beispiel für ein PowerShell-Skript:

$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

Sie können die Datei auch mithilfe des Azure-Portals oder über die Azure CLI hochladen.

Testen des Bereitstellungsskripts

1. Öffnen Sie im Azure-Portal die Ressourcengruppe, in der Sie die Containerinstanz und das Speicherkonto bereitgestellt haben.

2. Öffnen Sie die Containergruppe. Der Name der Standardcontainergruppe entspricht dem Projektnamen mit dem Zusatz cg. Die Containerinstanz weist den Status Wird ausgeführt auf.

3. Wählen Sie im Ressourcenmenü die Option Container aus. Der Name der Containerinstanz entspricht dem Projektnamen mit dem Zusatz container.

   

4. Klicken Sie auf Verbinden und dann auf Verbinden. Wenn Sie keine Verbindung mit der Containerinstanz herstellen können, starten Sie die Containergruppe neu, und versuchen Sie es noch mal.

5. Führen Sie im Konsolenbereich die folgenden Befehle aus:

   cd /mnt/azscripts/azscriptinput
   ls
   pwsh ./hello.ps1 "John Dole"
   

   Die Ausgabe ist Hello John Dole.

   

Verwenden einer Azure CLI-Containerinstanz

Sie müssen ein Speicherkonto erstellen und in die Containerinstanz einbinden, um Azure CLI-Skripts auf Ihrem Computer zu erstellen. Anschließend können Sie Ihr Skript in das Speicherkonto hochladen und in der Containerinstanz ausführen. Das Speicherkonto, das Sie zum Testen Ihres Skripts erstellen, ist nicht das gleiche Speicherkonto, das der Bereitstellungsskriptdienst zum Ausführen des Skripts verwendet. Der Bereitstellungsskriptdienst erstellt bei jeder Ausführung einen eindeutigen Namen als Dateifreigabe.

Verwenden einer Azure CLI-Containerinstanz

Mit der folgenden Bicep-Datei werden eine Containerinstanz und eine Dateifreigabe erstellt. Letztere wird dann in das Containerimage eingebunden:

@description('Specify a project name that is used for generating resource names.')
param projectName string

@description('Specify the resource location.')
param location string = resourceGroup().location

@description('Specify the container image.')
param containerImage string = 'mcr.microsoft.com/azure-cli:2.9.1'

@description('Specify the mount path.')
param mountPath string = '/mnt/azscripts/azscriptinput'

var storageAccountName = toLower('${projectName}store')
var fileShareName = '${projectName}share'
var containerGroupName = '${projectName}cg'
var containerName = '${projectName}container'

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-01-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
  }
}

resource fileshare 'Microsoft.Storage/storageAccounts/fileServices/shares@2023-01-01' = {
  name: '${storageAccountName}/default/${fileShareName}'
  dependsOn: [
    storageAccount
  ]
}

resource containerGroup 'Microsoft.ContainerInstance/containerGroups@2023-05-01' = {
  name: containerGroupName
  location: location
  properties: {
    containers: [
      {
        name: containerName
        properties: {
          image: containerImage
          resources: {
            requests: {
              cpu: 1
              memoryInGB: json('1.5')
            }
          }
          ports: [
            {
              protocol: 'TCP'
              port: 80
            }
          ]
          volumeMounts: [
            {
              name: 'filesharevolume'
              mountPath: mountPath
            }
          ]
          command: [
            '/bin/bash'
            '-c'
            'echo hello; sleep 1800'
          ]
        }
      }
    ]
    osType: 'Linux'
    volumes: [
      {
        name: 'filesharevolume'
        azureFile: {
          readOnly: false
          shareName: fileShareName
          storageAccountName: storageAccountName
          storageAccountKey: storageAccount.listKeys().keys[0].value
        }
      }
    ]
  }
}

Der Standardwert für den Einbindungspfad lautet /mnt/azscripts/azscriptinput. Dies ist der Pfad in der Containerinstanz, unter dem sie in die Dateifreigabe eingebunden wird.

Das in der Bicep-Datei angegebene Standardcontainerimage ist mcr.microsoft.com/azure-cli:2.9.1. Eine Liste mit den unterstützten Azure CLI-Versionen finden Sie hier. Das Bereitstellungsskript verwendet die verfügbaren CLI-Images von Microsoft Container Registry (MCR). Das Zertifizieren eines CLI-Images für ein Bereitstellungsskript dauert ungefähr einen Monat. Verwenden Sie nicht die CLI-Versionen, die innerhalb von 30 Tagen veröffentlicht wurden. Die Veröffentlichungsdaten für die Images finden Sie unter Versionshinweise für die Azure CLI. Wenn Sie eine nicht unterstützte Version verwenden, werden in der Fehlermeldung die unterstützten Versionen aufgelistet.

Die Bicep-Datei hält die Containerinstanz nach 1.800 Sekunden an. Sie haben 30 Minuten Zeit, bis die Containerinstanz in einen Beendigungsstatus wechselt und die Sitzung beendet wird.

Zum Bereitstellen der Bicep-Datei:

$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 Bicep file path and file name"
$resourceGroupName = "${projectName}rg"

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

Hochladen des Bereitstellungsskripts

Laden Sie Ihr Bereitstellungsskript in das Speicherkonto hoch. Dies ist ein PowerShell-Beispiel:

$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

Sie können die Datei auch mithilfe des Azure-Portals oder über die Azure CLI hochladen.

Testen des Bereitstellungsskripts

1. Öffnen Sie im Azure-Portal die Ressourcengruppe, in der Sie die Containerinstanz und das Speicherkonto bereitgestellt haben.

2. Öffnen Sie die Containergruppe. Der Name der Standardcontainergruppe entspricht dem Projektnamen mit dem Zusatz cg. Die Containerinstanz wird mit dem Status Wird ausgeführt angezeigt.

3. Wählen Sie im Ressourcenmenü die Option Container aus. Der Name der Containerinstanz entspricht dem Projektnamen mit dem Zusatz container.

   

4. Klicken Sie auf Verbinden und dann auf Verbinden. Wenn Sie keine Verbindung mit der Containerinstanz herstellen können, starten Sie die Containergruppe neu, und versuchen Sie es noch mal.

5. Führen Sie im Konsolenbereich die folgenden Befehle aus:

   cd /mnt/azscripts/azscriptinput
   ls
   ./hello.sh John Dole
   

   Die Ausgabe ist Hello John Dole.

   

Verwenden von Docker

Sie können ein vorkonfiguriertes Docker-Containerimage als Entwicklungsumgebung für Ihr Bereitstellungsskript nutzen. Informationen zum Installieren von Docker finden Sie hier. Darüber hinaus muss die Dateifreigabe so konfiguriert werden, dass das Verzeichnis mit den Bereitstellungsskripts in den Docker-Container eingebunden wird.

1. Pullen Sie das Containerimage für das Bereitstellungsskript auf den lokalen Computer:

   docker pull mcr.microsoft.com/azuredeploymentscripts-powershell:az10.0
   

   In diesem Beispiel wird die PowerShell-Version 4.3.0 verwendet.

   So rufen Sie ein CLI-Image per Pull aus MCR ab

   docker pull mcr.microsoft.com/azure-cli:2.52.0
   

   In diesem Beispiel wird Version 2.52.0 der CLI verwendet. Das Bereitstellungsskript verwendet die standardmäßigen CLI-Containerimages.

2. Führen Sie das Docker-Image lokal aus.

   docker run -v <host drive letter>:/<host directory name>:/data -it mcr.microsoft.com/azuredeploymentscripts-powershell:az10.0
   

   Ersetzen Sie <host drive letter> und <host directory name> durch einen vorhandenen Ordner auf dem freigegebenen Laufwerk. Der Ordner wird dem Ordner /data im Container zugeordnet. Bei der Zuordnung von D:\docker gilt beispielsweise:

   docker run -v d:/docker:/data -it mcr.microsoft.com/azuredeploymentscripts-powershell:az10.0
   

   -it bedeutet, dass das Containerimage aktiv bleibt.

   Ein CLI-Beispiel:

   docker run -v d:/docker:/data -it mcr.microsoft.com/azure-cli:2.52.0
   

3. Der folgende Screenshot zeigt die Ausführung eines PowerShell-Skripts, wenn sich auf dem freigegebenen Laufwerk eine Datei namens helloworld.ps1 befindet.

   

Nachdem das Skript erfolgreich getestet wurde, können Sie es als Bereitstellungsskript in Ihren Bicep-Dateien verwenden.

Nächste Schritte

In diesem Artikel haben Sie erfahren, wie Sie Entwicklungsumgebungen für Bereitstellungsskripts erstellen. Weitere Informationen:

Verwenden von Bereitstellungsskripts in Bicep