管理 Azure 自動化中的變數

變數資產是可用於自動化帳戶中所有 Runbook 和 DSC 組態的值。 您可以從 Azure 入口網站、從 PowerShell、在 PowerShell 內，或在 DSC 組態中加以管理。

自動化變數對下列案例很實用：

• 在多個 Runbook 或 DSC 組態之間共用值。

• 在相同 Runbook 或 DSC 組態的多個作業之間共用值。

• 從入口網站或 Windows PowerShell 命令列管理 Runbook 或 DSC 組態所使用的值。 例如，一組一般設定項目，例如特定的 VM 名稱清單、特定的資源群組、AD 網域名稱等。

Azure 自動化會保存變數，並使其可供使用，即使 Runbook 或 DSC 組態失敗也一樣。 此行為可讓一個 Runbook 或 DSC 組態設定另一個 Runbook 所使用的值，或下一次其執行時的相同 Runbook 或 DSC 組態。

Azure 自動化會安全地儲存每個加密變數。 當您建立變數時，可以 Azure 自動化做為安全資產，來指定其加密和儲存體。 建立變數之後，您就無法在未重新建立變數的情況下變更其加密狀態。 如果您有自動化帳戶變數儲存了尚未加密的敏感資料，您必須加以刪除，並將其重新建立為加密變數。 適用於雲端的 Microsoft Defender 建議將所有 Azure 自動化變數加密，如應加密自動化帳戶變數所說明。 如果您有要從此安全性建議中排除的未加密變數，請參閱從建議與安全分數中豁免資源，以建立豁免規則。

變數類型

使用 Azure 入口網站建立變數時，您必須從下拉式清單中指定資料類型，使入口網站可以對輸入變數的值顯示適當的控制項。 以下是可在 Azure 自動化中使用的變數類型：

• String
• 整數
• Datetime
• 布林值
• Null

變數不會受限於指定的資料類型。 如果您想要指定不同類型的值，必須使用 Windows PowerShell 來設定變數。 如果您指出 Not defined，變數的值會設定為 Null。 您必須使用 Set-AzAutomationVariable Cmdlet 或內部 Set-AutomationVariable Cmdlet 來設定此值。 您可以在 Runbook 中使用 Set-AutomationVariable，這些 Runbook 是要在 Azure 沙箱環境中執行，或在 Windows 混合式 Runbook 背景工作角色上執行。

您無法使用 Azure 入口網站來建立或變更複雜變數類型的值。 不過，您可以使用 Windows PowerShell 提供任何類型的值。 複雜類型會擷取為複雜物件類型的 Newtonsoft.Json.Linq.JProperty，而不是 PSObject 類型 PSCustomObject。

您可以藉由建立陣列或雜湊表，並將它儲存到變數中，來儲存多個值到單一變數。

存取變數的 PowerShell Cmdlet

下表中的 Cmdlet 會使用 PowerShell 來建立及管理自動化變數。 其會隨附於 Az 模組。

¹ 您無法使用這個 Cmdlet 來擷取加密變數的值。 若要這麼做，唯一的方法是在 Runbook 或 DSC 組態中使用內部 Get-AutomationVariable Cmdlet。 例如，若要查看加密變數的值，您可以建立 Runbook 來取得該變數，然後將其寫入輸出資料流：

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

存取變數的內部 Cmdlet

下表中的內部 Cmdlet 是用來存取 Runbook 和 DSC 組態中的變數。 這些 Cmdlet 隨附於全域模組 Orchestrator.AssetManagement.Cmdlets。 如需詳細資訊，請參閱內部 Cmdlet。

用來存取變數的 Python 函式

下表中的函式可用來存取 Python 2 和 3 Runbook 中的變數。 Python 3 Runbook 目前為預覽狀態。

建立並取得變數

使用 Azure 入口網站建立並取得變數

1. 從您的自動化帳戶，在左側窗格中，選取 [共用資源] 下的 [變數]。
2. 在 [變數] 頁面上，選取 [新增變數]。
3. 完成 [新增變數] 頁面上的選項，然後選取 [建立] 以儲存新變數。

在 Windows PowerShell 中建立及取得變數

您的 Runbook 或 DSC 組態會使用 New-AzAutomationVariable Cmdlet 來建立新的變數，並設定其初始值。 如果變數已加密，則呼叫應該使用 Encrypted 參數。 您的指令碼可以使用 Get-AzAutomationVariable 來擷取變數的值。

下列範例示範如何建立字串變數，然後傳回其值。

$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

下列範例示範如何建立具有複雜類型的變數，然後擷取其屬性。 在此情況下，會使用 Get-AzVM 中的虛擬機器物件來指定其屬性的子集。

$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

文字式 Runbook 範例

$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")

圖形化 Runbook 範例

在圖形化 Runbook 中，您可以新增內部 Cmdlet Get-AutomationVariable 或 Set-AutomationVariable 的活動。 只要以滑鼠右鍵按一下圖形化編輯器 [程式庫] 窗格中的每個變數，然後選取您想要的活動。

下圖示範的範例活動會在圖形化 Runbook 中使用簡單值來更新變數。 在此範例中，Get-AzVM 的活動會擷取單一 Azure 虛擬機器，並將電腦名稱稱儲存至現有的自動化字串變數。 連結是管線或順序都沒關係，因為程式碼在輸出中只預期單一物件。

下一步

• 若要深入了解用來存取變數的 Cmdlet，請參閱管理 Azure 自動化中的模組。

• 如需 Runbook 的一般資訊，請參閱 Azure 自動化中的 Runbook 執行。

• 如需 DSC 設定的詳細資料，請參閱 Azure 自動化狀態設定概觀。