Tutorial: Erstellen eines Automation PowerShell-Runbooks mithilfe einer verwalteten Identität

Artikel
05/11/2023

Dieses Tutorial führt Sie schrittweise durch das Erstellen eines PowerShell-Runbooks in Azure Automation, das eine verwaltete Identität anstelle des ausführenden Kontos verwendet, um mit Ressourcen zu interagieren. PowerShell-Runbooks basieren auf Windows PowerShell. Eine verwaltete Identität von Microsoft Entra ID ermöglicht Ihrem Runbook, einfach auf andere durch Microsoft Entra geschützte Ressourcen zuzugreifen.

In diesem Tutorial lernen Sie Folgendes:

Zuweisen von Berechtigungen zu verwalteten Identitäten
Erstellen eines PowerShell-Runbooks

Wenn Sie kein Azure-Abonnement besitzen, können Sie ein kostenloses Konto erstellen, bevor Sie beginnen.

Voraussetzungen

Ein Azure Automation-Konto mit mindestens einer benutzerseitig zugewiesenen verwalteten Identität. Weitere Informationen finden Sie unter Verwenden einer benutzerseitig zugewiesenen verwalteten Identität für ein Azure Automation-Konto.
Az-Module: Az.Accounts, Az.Automation, Az.ManagedServiceIdentity und Az.Compute, importiert in das Automation-Konto. Weitere Informationen finden Sie unter Importieren von Az-Modulen.
Das auf Ihrem Computer installierte PowerShell-Modul „Azure Az“. Informationen zur einer Installation oder einem Upgrade finden Sie unter Installieren des PowerShell-Moduls „Azure Az“. Az.ManagedServiceIdentity ist ein Vorschaumodul und wird nicht als Teil des Az-Moduls installiert. Führen Sie zur Installation Install-Module -Name Az.ManagedServiceIdentity aus.
Von eine virtuellen Azure-Computer. Da Sie diesen Computer starten und beenden, sollte es sich nicht um eine Produktions-VM handeln.
Allgemeine Vertrautheit mit Automation-Runbooks.

Zuweisen von Berechtigungen zu verwalteten Identitäten

Weisen Sie den verwalteten Identitäten Berechtigungen zu, damit sie einen virtuellen Computer beenden und starten können.

Melden Sie sich interaktiv mithilfe des Cmdlets Connect-AzAccount bei Azure an, und befolgen Sie die Anweisungen.

# Sign in to your Azure subscription
$sub = Get-AzSubscription -ErrorAction SilentlyContinue
if(-not ($sub)) {
    Connect-AzAccount
}

# If you have multiple subscriptions, set the one to use
# Select-AzSubscription -SubscriptionId <SUBSCRIPTIONID>

Geben Sie einen geeigneten Wert für die unten stehenden Variablen an, und führen Sie dann das Skript aus.

$resourceGroup = "resourceGroupName"

# These values are used in this tutorial
$automationAccount = "xAutomationAccount"
$userAssignedManagedIdentity = "xUAMI"

Verwenden Sie das PowerShell-Cmdlet New-AzRoleAssignment, um der systemseitig zugewiesenen verwalteten Identität eine Rolle zu zuweisen.

$role1 = "DevTest Labs User"

$SAMI = (Get-AzAutomationAccount -ResourceGroupName $resourceGroup -Name $automationAccount).Identity.PrincipalId
New-AzRoleAssignment `
    -ObjectId $SAMI `
    -ResourceGroupName $resourceGroup `
    -RoleDefinitionName $role1

Dieselbe Rollenzuweisung ist für die benutzerseitig zugewiesene verwaltete Identität erforderlich.

$UAMI = (Get-AzUserAssignedIdentity -ResourceGroupName $resourceGroup -Name $userAssignedManagedIdentity).PrincipalId
New-AzRoleAssignment `
    -ObjectId $UAMI `
    -ResourceGroupName $resourceGroup `
    -RoleDefinitionName $role1

Zusätzliche Berechtigungen sind für die systemseitig zugewiesene verwaltete Identität erforderlich, um die Cmdlets Get-AzUserAssignedIdentity und Get-AzAutomationAccount wie in diesem Tutorial verwendet auszuführen.
```
$role2 = "Reader"
New-AzRoleAssignment `
    -ObjectId $SAMI `
    -ResourceGroupName $resourceGroup `
    -RoleDefinitionName $role2
```

Erstellen eines PowerShell-Runbooks

Erstellen Sie ein Runbook, das die Ausführung durch eine der beiden verwalteten Identitäten zulässt. Das Runbook startet einen beendeten virtuellen Computer oder beendet einen ausgeführten virtuellen Computer.

Melden Sie sich beim Azure-Portal an, und navigieren Sie zu Ihrem Automation-Konto.
Wählen Sie unter Prozessautomatisierung die Option Runbooks aus.
Wählen Sie Runbook erstellen aus.
1. Nennen Sie das Runbook miTesting.
2. Wählen Sie in der Dropdownliste Runbooktyp die Option PowerShell aus.
3. Wählen Sie in der Dropdownliste Runtimeversion die Version 7.1 oder 5.1 aus.
4. Geben Sie eine anwendbare Beschreibung ein.
Klicken Sie auf Erstellen, um das Runbook zu erstellen.

Fügen Sie im Runbook-Editor den folgenden Code ein:

Param(
    [string]$ResourceGroup,
    [string]$VMName,
    [string]$Method,
    [string]$UAMI 
)

$automationAccount = "xAutomationAccount"

# Ensures you do not inherit an AzContext in your runbook
$null = Disable-AzContextAutosave -Scope Process

# Connect using a Managed Service Identity
try {
    $AzureConnection = (Connect-AzAccount -Identity).context
}
catch {
    Write-Output "There is no system-assigned user identity. Aborting." 
    exit
}

# set and store context
$AzureContext = Set-AzContext -SubscriptionName $AzureConnection.Subscription -DefaultProfile $AzureConnection

if ($Method -eq "SA") {
    Write-Output "Using system-assigned managed identity"
}
elseif ($Method -eq "UA") {
    Write-Output "Using user-assigned managed identity"

    # Connects using the Managed Service Identity of the named user-assigned managed identity
    $identity = Get-AzUserAssignedIdentity -ResourceGroupName $ResourceGroup -Name $UAMI -DefaultProfile $AzureContext

    # validates assignment only, not perms
    $AzAutomationAccount = Get-AzAutomationAccount -ResourceGroupName $ResourceGroup -Name $automationAccount -DefaultProfile $AzureContext
    if ($AzAutomationAccount.Identity.UserAssignedIdentities.Values.PrincipalId.Contains($identity.PrincipalId)) {
        $AzureConnection = (Connect-AzAccount -Identity -AccountId $identity.ClientId).context

        # set and store context
        $AzureContext = Set-AzContext -SubscriptionName $AzureConnection.Subscription -DefaultProfile $AzureConnection
    }
    else {
        Write-Output "Invalid or unassigned user-assigned managed identity"
        exit
    }
}
else {
    Write-Output "Invalid method. Choose UA or SA."
    exit
}

# Get current state of VM
$status = (Get-AzVM -ResourceGroupName $ResourceGroup -Name $VMName -Status -DefaultProfile $AzureContext).Statuses[1].Code

Write-Output "`r`n Beginning VM status: $status `r`n"

# Start or stop VM based on current state
if ($status -eq "Powerstate/deallocated") {
    Start-AzVM -Name $VMName -ResourceGroupName $ResourceGroup -DefaultProfile $AzureContext
}
elseif ($status -eq "Powerstate/running") {
    Stop-AzVM -Name $VMName -ResourceGroupName $ResourceGroup -DefaultProfile $AzureContext -Force
}

# Get new state of VM
$status = (Get-AzVM -ResourceGroupName $ResourceGroup -Name $VMName -Status -DefaultProfile $AzureContext).Statuses[1].Code  

Write-Output "`r`n Ending VM status: $status `r`n `r`n"

Write-Output "Account ID of current context: " $AzureContext.Account.Id

Überarbeiten Sie nach Bedarf im Editor in Zeile 8 den Wert für die Variable $automationAccount.
Wählen Sie Speichern und anschließend Testbereich aus.
Geben Sie für die Parameter RESOURCEGROUP und VMNAME die geeigneten Werte ein. Geben Sie SA für den Parameter METHOD ein und xUAMI für den Parameter UAMI. Das Runbook versucht, den Betriebszustand Ihres virtuellen Computers mithilfe der systemseitig zugewiesenen verwalteten Identität zu ändern.

Wählen Sie Starten aus. Nach Abschluss des Runbooks sollte die Ausgabe in etwa wie folgt aussehen:

 Beginning VM status: PowerState/deallocated

OperationId : 5b707401-f415-4268-9b43-be1f73ddc54b
Status      : Succeeded
StartTime   : 8/3/2021 10:52:09 PM
EndTime     : 8/3/2021 10:52:50 PM
Error       : 
Name        : 

 Ending VM status: PowerState/running 

Account ID of current context: 
MSI@50342

Ändern Sie den Wert des Parameters METHOD in UA.

Wählen Sie Starten aus. Das Runbook versucht, den Betriebszustand Ihres virtuellen Computers mithilfe der benannten benutzerseitig zugewiesenen verwalteten Identität zu ändern. Nach Abschluss des Runbooks sollte die Ausgabe in etwa wie folgt aussehen:

Using user-assigned managed identity

 Beginning VM status: PowerState/running 

OperationId : 679fcadf-d0b9-406a-9282-66bc211a9fbf
Status      : Succeeded
StartTime   : 8/3/2021 11:06:03 PM
EndTime     : 8/3/2021 11:06:49 PM
Error       : 
Name        : 

 Ending VM status: PowerState/deallocated 

Account ID of current context: 
9034f5d3-c46d-44d4-afd6-c78aeab837ea

Bereinigen von Ressourcen

Um alle nicht mehr benötigten Ressourcen zu entfernen, führen Sie das folgende Runbook aus.

#Remove runbook
Remove-AzAutomationRunbook `
    -ResourceGroupName $resourceGroup `
    -AutomationAccountName $automationAccount `
    -Name "miTesting" `
    -Force

# Remove role assignments
Remove-AzRoleAssignment `
    -ObjectId $UAMI `
    -ResourceGroupName $resourceGroup `
    -RoleDefinitionName $role1

Remove-AzRoleAssignment `
    -ObjectId $SAMI `
    -ResourceGroupName $resourceGroup `
    -RoleDefinitionName $role2

Remove-AzRoleAssignment `
    -ObjectId $SAMI `
    -ResourceGroupName $resourceGroup `
    -RoleDefinitionName $role1

Nächste Schritte

In diesem Tutorial haben Sie ein PowerShell-Runbook in Azure Automation erstellt, das eine verwaltete Identität anstelle des ausführenden Kontos verwendet hat, um mit Ressourcen zu interagieren. Informationen zu PowerShell-Workflow-Runbooks finden Sie unter:

Tutorial: Erstellen eines PowerShell-Workflow-Runbooks

Freigeben über