在 Azure 自動化中編輯文字式 Runbook

  • 發行項

您可以使用 Azure 自動化中的文字式編輯器來編輯 PowerShell Runbook 和 PowerShell 工作流程 Runbook。 此編輯器具有其他程式碼編輯器的一般功能，例如 IntelliSense。 其也會搭配其他特殊功能來使用色彩編碼，以協助您存取 Runbook 通用的資源。

此文字式編輯器具有將 Cmdlet、資產、子 Runbook 程式碼插入 Runbook 的功能。 您不需要自行輸入程式碼，而是可以從可用資源的清單中選取，編輯器就會將適當的程式碼插入 Runbook 中。

Azure 自動化中的每個 Runbook 有兩個版本，「草稿」和「已發佈」。 您編輯 Runbook 的「草稿」版本然後發佈，讓它可以執行。 無法編輯已發佈版本。 如需詳細資訊，請參閱發佈 Runbook。

本文提供執行與此編輯器不同的功能的詳細步驟。 這些不適用於圖形化 Runbook。 若要使用這些 Runbook，請參閱 Azure 自動化中的圖形化撰寫。

重要

請勿在任何專為 Az 模組執行的指令碼中包含關鍵字 "AzureRm"。 就算只是在註解中包含關鍵字，也可能導致 AzureRm 載入，然後與 Az 模組發生衝突。

使用 Azure 入口網站編輯 Runbook

  1. 在 Azure 入口網站中，選取您的自動化帳戶。
  2. 在 [程序自動化] 底下選取 [Runbook] 開啟 Runbook 清單。
  3. 選擇要編輯的 Runbook，然後按一下 [編輯]。
  4. 編輯 Runbook。
  5. 完成編輯時按一下 [儲存] 。
  6. 如果您要發佈 Runbook 的最新草稿版本，請按一下 [發佈]。

將 Cmdlet 插入 Runbook

  1. 在文字式編輯器的 [畫布] 中，將游標移至您要放置 Cmdlet 的位置。
  2. 在程式庫控制項中，展開 Cmdlet 節點。
  3. 展開包含所要使用 Cmdlet 的模組。
  4. 以滑鼠右鍵按一下要插入的 Cmdlet 名稱，然後選取 [新增至畫布]。 如果 Cmdlet 有一個以上的參數集合，編輯器會新增預設集合。 您也以展開 Cmdlet 以選取不同的參數集合。
  5. 請注意，會插入 Cmdlet 的程式碼且具有參數的完整清單。
  6. 針對任何必要的參數，提供適當的值來取代以角括弧 (<>) 括住的值。 移除您不需要的任何參數。

將子 Runbook 的程式碼插入 Runbook

  1. 在文字式編輯器的 [畫布] 中，將游標移至您要放置子 Runbook 程式碼的位置。
  2. 在程式庫控制項中，展開 Runbook 節點。
  3. 以滑鼠右鍵按一下要插入的 Runbook，然後選取 [新增至畫布]。
  4. 會插入子 Runbook 的程式碼且具有任何 Runbook 參數的預留位置。
  5. 針對每個參數以適當值取代預留位置。

將資產插入 Runbook

  1. 在文字式編輯器的 [畫布] 控制項中，將游標移至您要放置子 Runbook 程式碼的位置。
  2. 在程式庫控制項中，展開 [資產] 節點。
  3. 展開所需資產類型的節點。
  4. 以滑鼠右鍵按一下要插入的資產名稱，然後選取 [新增至畫布]。 針對變數資產，根據您要取得還是設定變數而定，選取 [將「取得變數」新增至畫布] 或 [將「設定變數」新增至畫布]。
  5. 請注意，資產的程式碼會插入 Runbook 中。

使用 Windows PowerShell 編輯 Azure 自動化 Runbook

若要使用 Windows PowerShell 編輯 Runbook，請使用您選擇的編輯器，然後將 Runbook 儲存為 .ps1 檔案。 您可以使用 Export-AzAutomationRunbook Cmdlet 來擷取 Runbook 的內容。 您可以使用 Import-AzAutomationRunbook Cmdlet，將現有的草稿 Runbook 取代為已修改的 Runbook。

使用 Windows PowerShell 擷取 Runbook 的內容

下列命令範例會顯示如何擷取 Runbook 的指令碼，並將它儲存到指令碼檔案。 在此範例中會擷取草稿版本。 也可以擷取「已發佈」版本的 Runbook，雖然這個版本無法變更。

$resourceGroupName = "MyResourceGroup"
$automationAccountName = "MyAutomatonAccount"
$runbookName = "Hello-World"
$scriptFolder = "c:\runbooks"

Export-AzAutomationRunbook -Name $runbookName -AutomationAccountName $automationAccountName -ResourceGroupName $resourceGroupName -OutputFolder $scriptFolder -Slot Draft

使用 Windows PowerShell 變更 Runbook 的內容

下列範例命令顯示如何以指令碼檔案內容取代現有 Runbook 的內容。

$resourceGroupName = "MyResourceGroup"
$automationAccountName = "MyAutomatonAccount"
$runbookName = "Hello-World"
$scriptFolder = "c:\runbooks"

Import-AzAutomationRunbook -Path "$scriptfolder\Hello-World.ps1" -Name $runbookName -Type PowerShell -AutomationAccountName $automationAccountName -ResourceGroupName $resourceGroupName -Force
Publish-AzAutomationRunbook -Name $runbookName -AutomationAccountName $automationAccountName -ResourceGroupName $resourceGroupName

下一步