Variabelen beheren in Azure Automation

Variabele assets zijn waarden die beschikbaar zijn voor alle runbooks en DSC-configuraties in uw Automation-account. U kunt deze beheren vanuit de Azure Portal, vanuit PowerShell, binnen een runbook of in een DSC-configuratie.

Automation-variabelen zijn handig voor de volgende scenario's:

• Een waarde delen tussen meerdere runbooks of DSC-configuraties.

• Een waarde delen tussen meerdere taken uit hetzelfde runbook of DSC-configuratie.

• Een waarde beheren die wordt gebruikt door runbooks of DSC-configuraties vanuit de portal of vanaf de PowerShell-opdrachtregel. Een voorbeeld is een set algemene configuratie-items, zoals een specifieke lijst met VM-namen, een specifieke resourcegroep, een AD-domeinnaam en meer.

Azure Automation worden variabelen persistent gemaakt en beschikbaar gemaakt, zelfs als een runbook of DSC-configuratie mislukt. Met dit gedrag kan één runbook of DSC-configuratie een waarde instellen die vervolgens wordt gebruikt door een ander runbook, of door hetzelfde runbook of DSC-configuratie de volgende keer dat het wordt uitgevoerd.

Azure Automation versleutelde variabelen veilig opgeslagen. Wanneer u een variabele maakt, kunt u de versleuteling en opslag ervan opgeven door Azure Automation als een beveiligde asset. Nadat u de variabele hebt gemaakt, kunt u de versleutelingsstatus ervan niet meer wijzigen zonder de variabele opnieuw te maken. Als u met Automation-accountvariabelen gevoelige gegevens opslaat die nog niet zijn versleuteld, moet u deze verwijderen en opnieuw maken als versleutelde variabelen. Een aanbeveling van Microsoft Defender voor Cloud is om alle Azure Automation zoals beschreven in Automation-accountvariabelen moeten worden versleuteld. Als u niet-versleutelde variabelen hebt die u wilt uitsluiten van deze beveiligingsaanbeveling, raadpleegt u Een resource uitsluiten van aanbevelingen en de beveiligingsscore om een uitzonderingsregel te maken.

Variabeletypen

Wanneer u een variabele maakt met de Azure Portal, moet u een gegevenstype opgeven in de vervolgkeuzelijst, zodat in de portal het juiste besturingselement voor het invoeren van de variabele waarde kan worden weergegeven. Hier volgen de variabeletypen die beschikbaar zijn in Azure Automation:

• Tekenreeks
• Geheel getal
• DateTime
• Booleaans
• Null

De variabele is niet beperkt tot het opgegeven gegevenstype. U moet de variabele instellen met Windows PowerShell als u een waarde van een ander type wilt opgeven. Als u Not defined aangeeft, wordt de waarde van de variabele ingesteld op Null. U moet de waarde instellen met de cmdlet Set-AzAutomationVariable of de interne Set-AutomationVariable cmdlet . U gebruikt de Set-AutomationVariable in uw runbooks die zijn bedoeld om te worden uitgevoerd in de Azure-sandboxomgeving of op een Windows Hybrid Runbook Worker.

U kunt de Azure Portal gebruiken om de waarde voor een complex variabeletype te maken of te wijzigen. U kunt echter een waarde van elk type met behulp van Windows PowerShell. Complexe typen worden opgehaald als een Newtonsoft.Json.Linq.JProperty voor een complex objecttype in plaats van een PSObject-type PSCustomObject.

U kunt meerdere waarden opslaan in één variabele door een matrix of hashtabel te maken en deze op te slaan in de variabele .

PowerShell-cmdlets voor toegang tot variabelen

De cmdlets in de volgende tabel maken en beheren Automation-variabelen met PowerShell. Ze worden als onderdeel van de Az-modules verzenden.

¹ U kunt deze cmdlet niet gebruiken om de waarde van een versleutelde variabele op te halen. De enige manier om dit te doen, is met behulp van de interne Get-AutomationVariable cmdlet in een runbook- of DSC-configuratie. Als u bijvoorbeeld de waarde van een versleutelde variabele wilt zien, kunt u een runbook maken om de variabele op te halen en deze vervolgens naar de uitvoerstroom te schrijven:

$encryptvar = Get-AutomationVariable -Name TestVariable
Write-output "The encrypted value of the variable is: $encryptvar"

Interne cmdlets voor toegang tot variabelen

De interne cmdlets in de volgende tabel worden gebruikt voor toegang tot variabelen in uw runbooks en DSC-configuraties. Deze cmdlets worden bij de globale module Orchestrator.AssetManagement.Cmdlets gebruikt. Zie Interne cmdlets voor meer informatie.

Python-functies voor toegang tot variabelen

De functies in de volgende tabel worden gebruikt voor toegang tot variabelen in een Python 2- en 3-runbook. Python 3-runbooks zijn momenteel beschikbaar als preview-versie.

Een variabele maken en op halen

Maak een variabele en haal deze op met behulp van Azure Portal

1. Selecteer in uw Automation-account in het linkerdeelvenster Variabelen onder Gedeelde resources.
2. Selecteer op de pagina Variabelen de optie Een variabele toevoegen.
3. Voltooi de opties op de pagina Nieuwe variabele en selecteer vervolgens Maken om de nieuwe variabele op te slaan.

Maak en haal een variabele op in Windows PowerShell

Uw runbook of DSC-configuratie gebruikt de cmdlet om een nieuwe variabele te maken New-AzAutomationVariable en de initiële waarde in te stellen. Als de variabele is versleuteld, moet de aanroep de Encrypted parameter gebruiken. Met uw script kan de waarde van de variabele worden opgehaald met behulp van Get-AzAutomationVariable .

In het volgende voorbeeld ziet u hoe u een tekenreeksvariabele maakt en vervolgens de waarde retourneert.

$rgName = "ResourceGroup01"
$accountName = "MyAutomationAccount"
$variableValue = "My String"

New-AzAutomationVariable -ResourceGroupName "ResourceGroup01" 
-AutomationAccountName "MyAutomationAccount" -Name 'MyStringVariable' `
-Encrypted $false -Value 'My String'
$string = (Get-AzAutomationVariable -ResourceGroupName "ResourceGroup01" `
-AutomationAccountName "MyAutomationAccount" -Name 'MyStringVariable').Value

In het volgende voorbeeld ziet u hoe u een variabele met een complex type maakt en vervolgens de eigenschappen ervan op haalt. In dit geval wordt een virtuele-machineobject van Get-AzVM gebruikt om een subset van de eigenschappen op te geven.

$rgName = "ResourceGroup01"
$accountName = "MyAutomationAccount"

$vm = Get-AzVM -ResourceGroupName "ResourceGroup01" -Name "VM01" | Select Name, Location, Extensions
New-AzAutomationVariable -ResourceGroupName "ResourceGroup01" -AutomationAccountName "MyAutomationAccount" -Name "MyComplexVariable" -Encrypted $false -Value $vm

$vmValue = Get-AzAutomationVariable -ResourceGroupName "ResourceGroup01" `
-AutomationAccountName "MyAutomationAccount" -Name "MyComplexVariable"

$vmName = $vmValue.Value.Name
$vmTags = $vmValue.Value.Tags

Voorbeelden van tekstrunbook

$rgName = "ResourceGroup01"
$accountName = "MyAutomationAccount"

$numberOfIterations = Get-AutomationVariable -Name "numberOfIterations"
$numberOfRunnings = Get-AutomationVariable -Name "numberOfRunnings"
$sampleMessage = Get-AutomationVariable -Name "sampleMessage"

Write-Output "Runbook has been run $numberOfRunnings times."

for ($i = 1; $i -le $numberOfIterations; $i++) {
    Write-Output "$i`: $sampleMessage"
}
Set-AutomationVariable -Name numberOfRunnings -Value ($numberOfRunnings += 1)

import automationassets
from automationassets import AutomationAssetNotFound

# get a variable
value = automationassets.get_automation_variable("test-variable")
print value

# set a variable (value can be int/bool/string)
automationassets.set_automation_variable("test-variable", True)
automationassets.set_automation_variable("test-variable", 4)
automationassets.set_automation_variable("test-variable", "test-string")

# handle a non-existent variable exception
try:
    value = automationassets.get_automation_variable("nonexisting variable")
except AutomationAssetNotFound:
    print "variable not found"

import automationassets
from automationassets import AutomationAssetNotFound

# get a variable
value = automationassets.get_automation_variable("test-variable")
print value

# set a variable (value can be int/bool/string)
automationassets.set_automation_variable("test-variable", True)
automationassets.set_automation_variable("test-variable", 4)
automationassets.set_automation_variable("test-variable", "test-string")

# handle a non-existent variable exception
try:
    value = automationassets.get_automation_variable("nonexisting variable")
except AutomationAssetNotFound:
    print ("variable not found")

Grafische runbookvoorbeelden

In een grafisch runbook kunt u activiteiten toevoegen voor de interne cmdlets Get-AutomationVariable of Set-AutomationVariable. Klik met de rechtermuisknop op elke variabele in het deelvenster Bibliotheek van de grafische editor en selecteer de activiteit die u wilt.

In de volgende afbeelding ziet u voorbeeldactiviteiten voor het bijwerken van een variabele met een eenvoudige waarde in een grafisch runbook. In dit voorbeeld wordt met de activiteit voor één virtuele Azure-machine opgehaald en wordt de computernaam opgeslagen in een bestaande Get-AzVM Automation-tekenreeksvariabele. Het maakt niet uit of de koppeling een pijplijn of reeks is, omdat de code slechts één object in de uitvoer verwacht.

Volgende stappen

• Zie Modules beheren in Azure Automation voor meer informatie over de cmdlets die worden gebruikt voor toegang tot variabelen.

• Zie Runbookuitvoering in Azure Automation voor algemene informatie over runbooks.

• Zie overzicht van Azure Automation State Configuration DSC-configuraties.