Min första PowerShell-runbookMy first PowerShell runbook

Den här självstudien beskriver steg för steg hur du skapar en PowerShell-runbook i Azure Automation.This tutorial walks you through the creation of a PowerShell runbook in Azure Automation. Du börjar med en enkel Runbook som du testar och publicerar medan du lär dig hur du spårar statusen för Runbook-jobbet.You start with a simple runbook that you test and publish while you learn how to track the status of the runbook job. Sedan ändrar du runbook-jobbet så att det hanterar Azure-resurser. I det här exemplet ska det starta en virtuell dator i Azure.Then you modify the runbook to actually manage Azure resources, in this case starting an Azure virtual machine. Slutligen gör du runbooken mer robust genom att lägga till Runbook-parametrar.Lastly, you make the runbook more robust by adding runbook parameters.

FörutsättningarPrerequisites

För att slutföra den här självstudien, finns följande förhandskrav:To complete this tutorial, you need the following prerequisites:

Skapa ny RunbookCreate new runbook

Du börjar med att skapa en enkel Runbook som visar texten Hello World.You start by creating a simple runbook that outputs the text Hello World.

  1. Öppna ditt Automation-konto på Azure Portal.In the Azure portal, open your Automation account.
  2. Öppna listan över runbooks genom att klicka på Runbooks under process automatisering .Click Runbooks under Process Automation to open the list of runbooks.
  3. Skapa en ny Runbook genom att klicka på knappen + Lägg till en Runbook och skapa sedan en ny Runbook.Create a new runbook by clicking the + Add a runbook button and then Create a new runbook.
  4. Ge runbooken namnet MyFirstRunbook-PowerShell.Give the runbook the name MyFirstRunbook-PowerShell.
  5. I det här fallet ska du skapa en PowerShell- Runbook så välj PowerShell som Runbook-typ.In this case, you're going to create a PowerShell runbook so select Powershell for Runbook type.
  6. Klicka på Skapa för att skapa runbooken och öppna textredigeraren.Click Create to create the runbook and open the textual editor.

Lägg till kod i RunbookAdd code to the runbook

Du kan antingen skriva kod direkt i runbooken eller välja cmdlets, runbooks och resurser från bibliotekskontrollen och lägga till dem i runbooken med eventuella relaterade parametrar.You can either type code directly into the runbook, or you can select cmdlets, runbooks, and assets from the Library control and have them added to the runbook with any related parameters. I den här genom gången skriver du direkt i runbooken.For this walkthrough, you type directly in the runbook.

  1. Din Runbook är tom för tillfället, Skriv Write-output "Hello World".Your runbook is currently empty, type Write-Output "Hello World." i innehållsdelen av skriptet.in the body of the script.

    Hello World

  2. Spara runbooken genom att klicka på Spara.Save the runbook by clicking Save.

Testa runbooken Test the runbook

Innan du publicerar runbook-jobbet så att den blir tillgänglig i produktionsmiljön testar du den och kontrollerar att den fungerar som den ska.Before you publish the runbook to make it available in production, you want to test it to make sure that it works properly. När du testar en runbook kör du dess utkastversion och visar dess utdata interaktivt.When you test a runbook, you run its Draft version and view its output interactively.

  1. Öppna testfönstret genom att klicka på Testfönster.Click Test pane to open the Test pane.

  2. Starta testet genom att klicka på Starta.Click Start to start the test. Detta bör vara det enda aktiverade alternativet.This should be the only enabled option.

  3. Ett runbook-jobb skapas och dess status visas.A runbook job is created and its status displayed.

    Jobbets status börjar i , vilket betyder att det väntar på att en Runbook Worker i molnet ska bli tillgänglig.The job status starts as Queued indicating that it's waiting for a runbook worker in the cloud to come available. Den flyttar till Start när en arbets tagare anlitar jobbet och Kör sedan när runbooken faktiskt börjar köras.It moves to Starting when a worker claims the job, and then Running when the runbook actually starts running.

  4. När runbook-jobbet är klart visas dess utdata.When the runbook job completes, its output is displayed. I så fall bör du se Hello World.In your case, you should see Hello World.

    Utdata i testfönstret

  5. Gå tillbaka till arbetsytan genom att stänga testfönstret.Close the Test pane to return to the canvas.

Publicera och starta runbookenPublish and start the runbook

Det runbook-jobb som du har skapat är fortfarande i utkastläge.The runbook that you created is still in Draft mode. Den måste publiceras innan du kan köra den i produktion.It must be published before you can run it in production. När du publicerar en runbook skriver du över den befintliga publicerade versionen med utkastversionen.When you publish a runbook, you overwrite the existing Published version with the Draft version. I så fall har du inte någon publicerad version än eftersom du nyss skapade runbooken.In your case, you don't have a Published version yet because you just created the runbook.

  1. Klicka på Publicera för att publicera runbooken och sedan på Ja när du uppmanas att göra det.Click Publish to publish the runbook and then Yes when prompted.

  2. Om du rullar åt vänster för att Visa Runbook i fönstret Runbooks nu visas redigerings statusen publicerad.If you scroll left to view the runbook in the Runbooks pane now, it shows an Authoring Status of Published.

  3. Bläddra tillbaka åt höger för att visa fönstret för MyFirstRunbook-PowerShell.Scroll back to the right to view the pane for MyFirstRunbook-PowerShell. Vi kan använda alternativen längs överkanten för att starta runbooken, visa runbooken, schemalägga den så att den startar senare eller skapa en webhook så att den kan startas via ett HTTP-anrop.The options across the top allow us to start the runbook, view the runbook, schedule it to start at some time in the future, or create a webhook so it can be started through an HTTP call.

  4. Du vill starta runbooken, så klicka på Start och sedan på OK när sidan starta Runbook öppnas.You want to start the runbook, so click Start and then click Ok when the Start Runbook page opens.

  5. En jobb sida öppnas för det Runbook-jobb som du skapade.A job page is opened for the runbook job that you created. Du kan stänga det här fönstret, men i det här fallet lämnar du det öppet så att du kan se jobbets förlopp.You can close this pane, but in this case you leave it open so you can watch the job's progress.

  6. Jobbets status visas i jobb Sammanfattning och matchar de status värden som du såg när du testade runbooken.The job status is shown in Job Summary and matches the statuses that you saw when you tested the runbook.

    Jobbsammanfattning

  7. När Runbook-statusen har slutförtsklickar du på utdataunder Översikt .Once the runbook status shows Completed, under Overview click Output. Fönstret utdata öppnas och du kan se din Hello World.The Output pane is opened, and you can see your Hello World.

    Jobbutdata

  8. Stäng sidan utdata.Close the Output page.

  9. Klicka på Alla loggar för att öppna fönstret Strömmar för runbook-jobbet.Click All Logs to open the Streams pane for the runbook job. Du bör bara se Hello World i utdataströmmen, men utdata kan visa andra strömmar för ett Runbook-jobb, till exempel utförlig och fel, om Runbook skriver till dem.You should only see Hello World in the output stream, but this output can show other streams for a runbook job such as Verbose and Error if the runbook writes to them.

    Alla loggar

  10. Stäng sidan strömmar och jobb sidan för att återgå till MyFirstRunbook-PowerShell-sidan.Close the Streams page and the Job page to return to the MyFirstRunbook-PowerShell page.

  11. Klicka på jobb under informationför att öppna fönstret jobb för denna Runbook.Under Details, click Jobs to open the Jobs pane for this runbook. Den här sidan visar alla jobb som skapats av denna Runbook.This page lists all of the jobs created by this runbook. Nu bör du endast se ett jobb eftersom du bara körde jobbet en gång.You should only see one job listed since you only ran the job once.

    Jobblista

  12. Du kan klicka på det här jobbet för att öppna samma jobbfönster som du visade när du startade runbook-jobbet.You can click this job to open the same Job pane that you viewed when you started the runbook. Med den här åtgärden kan du gå tillbaka i tiden och Visa information om alla jobb som har skapats för en viss Runbook.This action allows you to go back in time and view the details of any job that was created for a particular runbook.

Lägg till autentisering för att hantera Azure-resurserAdd authentication to manage Azure resources

Du har testat och publicerat din runbook, men hittills gör den egentligen inget användbart.You've tested and published your runbook, but so far it doesn't do anything useful. Du vill att den ska hantera Azure-resurser.You want to have it manage Azure resources. Det går inte att göra om du inte har autentiserat med en kör som-anslutning som skapas automatiskt när du skapar ett Automation-konto.It is not able to do that though unless You have it authenticate using a Run As connection that is automatically created when you create your automation account. Du använder kör som-anslutningen med cmdleten Connect-AzureRmAccount .You use the Run As connection with the Connect-AzureRmAccount cmdlet. Om du hanterar resurser över flera prenumerationer måste du använda parametern -AzureRmContext tillsammans med Get-AzureRmContext.If you are managing resources across multiple subscriptions, you need to use the -AzureRmContext parameter along with Get-AzureRmContext.

# Ensures you do not inherit an AzureRMContext in your runbook
Disable-AzureRmContextAutosave –Scope Process

$connection = Get-AutomationConnection -Name AzureRunAsConnection
Connect-AzureRmAccount -ServicePrincipal -Tenant $connection.TenantID `
-ApplicationID $connection.ApplicationID -CertificateThumbprint $connection.CertificateThumbprint

$AzureContext = Select-AzureRmSubscription -SubscriptionId $connection.SubscriptionID

Get-AzureRmVM -ResourceGroupName myResourceGroup -AzureRmContext $AzureContext
  1. Öppna text redigeraren genom att klicka på redigera på MyFirstRunbook-PowerShell-sidan.Open the textual editor by clicking Edit on the MyFirstRunbook-PowerShell page.

  2. Du behöver inte längre Skriv resultatet , så gå vidare och ta bort den.You don't need the Write-Output line anymore, so go ahead and delete it.

  3. Skriv eller kopiera och klistra in följande kod som hanterar autentiseringen med ditt ”Kör som”-konto för Automation:Type or copy and paste the following code that handles the authentication with your Automation Run As account:

    # Ensures you do not inherit an AzureRMContext in your runbook
    Disable-AzureRmContextAutosave –Scope Process
    
    $connection = Get-AutomationConnection -Name AzureRunAsConnection
    Connect-AzureRmAccount -ServicePrincipal -Tenant $connection.TenantID `
    -ApplicationId $connection.ApplicationID -CertificateThumbprint $connection.CertificateThumbprint
    

    Viktigt

    Add-AzureRmAccount och login-AzureRmAccount är nu alias för Connect-AzureRmAccount.Add-AzureRmAccount and Login-AzureRmAccount are now aliases for Connect-AzureRMAccount. Om cmdleten Connect-AzureRMAccount inte finns kan du använda Add-AzureRMAccount eller login -AzureRMAccount, eller så kan du uppdatera dina moduler i ditt Automation-konto till de senaste versionerna.If the Connect-AzureRMAccount cmdlet does not exist, you can use Add-AzureRmAccount or Login-AzureRmAccount, or you can update your modules in your Automation Account to the latest versions.

  4. Klicka på test fönster så att du kan testa runbooken.Click Test pane so that you can test the runbook.

  5. Starta testet genom att klicka på Starta.Click Start to start the test. När testet är klart visas utdata som liknar de nedan, med grundläggande information från ditt konto.Once it completes, you should receive output similar to the following, displaying basic information from your account. Det här resultatet bekräftar att kör som-kontot är giltigt.This output confirms that the Run As Account is valid.

    Autentisera

Lägg till kod för att starta en virtuell datorAdd code to start a virtual machine

Nu när din Runbook autentiseras till din Azure-prenumeration kan du hantera resurser.Now that your runbook is authenticating to your Azure subscription, you can manage resources. Du lägger till ett kommando för att starta en virtuell dator.You add a command to start a virtual machine. Du kan välja vilken virtuell dator som helst i din Azure-prenumeration och nu hårdkoda du det namnet i runbooken.You can pick any virtual machine in your Azure subscription, and for now you hardcode that name in the runbook.

  1. Efter Connect-AzureRmAccountskriver du Start-AzureRmVM-Name "VMName"-ResourceGroupName "NameofResourceGroup" och anger namn och resurs grupp namn för den virtuella datorn som ska startas.After Connect-AzureRmAccount, type Start-AzureRmVM -Name 'VMName' -ResourceGroupName 'NameofResourceGroup' providing the name and Resource Group name of the virtual machine to start.

    # Ensures you do not inherit an AzureRMContext in your runbook
    Disable-AzureRmContextAutosave –Scope Process
    
    $connection = Get-AutomationConnection -Name AzureRunAsConnection
    Connect-AzureRmAccount -ServicePrincipal -Tenant $connection.TenantID `
    -ApplicationID $connection.ApplicationID -CertificateThumbprint $connection.CertificateThumbprint
    Start-AzureRmVM -Name 'VMName' -ResourceGroupName 'ResourceGroupName'
    
  2. Spara runbooken och klicka sedan på test fönster så att du kan testa den.Save the runbook and then click Test pane so that you can test it.

  3. Starta testet genom att klicka på Starta.Click Start to start the test. När det är klart kontrollerar du att den virtuella datorn har startat.Once it completes, check that the virtual machine was started.

Lägg till en indataparameterAdd an input parameter

Din Runbook startar för närvarande den virtuella datorn som du hårdkodad i runbooken, men det skulle vara mer användbart om du anger den virtuella datorn när runbooken startas.Your runbook currently starts the virtual machine that you hardcoded in the runbook, but it would be more useful if you specify the virtual machine when the runbook is started. Du lägger till indataparametrar till Runbook för att tillhandahålla den funktionen.You add input parameters to the runbook to provide that functionality.

  1. Lägg till parametrar för VMName och ResourceGroupName i runbooken och Använd dessa variabler med cmdleten Start-AzureRmVM som i följande exempel.Add parameters for VMName and ResourceGroupName to the runbook and use these variables with the Start-AzureRmVM cmdlet as in the following example.

    Param(
     [string]$VMName,
     [string]$ResourceGroupName
    )
    # Ensures you do not inherit an AzureRMContext in your runbook
    Disable-AzureRmContextAutosave –Scope Process
    
    $connection = Get-AutomationConnection -Name AzureRunAsConnection
    Connect-AzureRmAccount -ServicePrincipal -Tenant $connection.TenantID `
    -ApplicationID $connection.ApplicationID -CertificateThumbprint $connection.CertificateThumbprint
    Start-AzureRmVM -Name $VMName -ResourceGroupName $ResourceGroupName
    
  2. Spara runbooken och öppna Testfönster.Save the runbook and open the Test pane. Nu kan du ange värden för de två indatavariablerna som används i testet.You can now provide values for the two input variables that are used in the test.

  3. Stäng Testfönster.Close the Test pane.

  4. Klicka på Publicera för att publicera den nya versionen av runbooken.Click Publish to publish the new version of the runbook.

  5. Stoppa den virtuella dator som du startade i föregående steg.Stop the virtual machine that you started in the previous step.

  6. Starta runbooken genom att klicka på OK .Click OK to start the runbook. Skriv VMName och ResourceGroupName för den virtuella datorn som du ska starta.Type in the VMName and ResourceGroupName for the virtual machine that you're going to start.

    Skicka parameterPass Parameter

  7. När runbooken har slutförts kontrollerar du att den virtuella datorn har startat.When the runbook completes, check that the virtual machine was started.

Skillnader från PowerShell WorkflowDifferences from PowerShell Workflow

PowerShell-runbookflöden har samma livscykel, funktioner och hantering som runbookflöden för PowerShell-arbetsflöden, men det finns vissa skillnader och begränsningar:PowerShell runbooks have the same lifecycle, capabilities, and management as PowerShell Workflow runbooks but there are some differences and limitations:

  1. PowerShell-runbooks körs snabbt jämfört med PowerShell Workflow-runbooks eftersom det inte krävs något kompileringssteg.PowerShell runbooks run fast compared to PowerShell Workflow runbooks as they don’t have compilation step.
  2. PowerShell Workflow-Runbooks stöder kontroll punkter, med hjälp av kontroll punkter, Runbook-flöden för PowerShell-arbetsflöden kan återupptas från valfri punkt i runbooken.PowerShell Workflow runbooks support checkpoints, using checkpoints, PowerShell Workflow runbooks can resume from any point in the runbook. PowerShell-Runbooks kan bara fortsätta från början.PowerShell runbooks can only resume from the beginning.
  3. PowerShell Workflow-Runbooks stöder parallell och seriell körning.PowerShell Workflow runbooks support parallel and serial execution. PowerShell-Runbooks kan bara köra kommandon seriellt.PowerShell runbooks can only execute commands serially.
  4. I en PowerShell Workflow-Runbook kan en aktivitet, ett kommando eller ett skript block ha sin egen körnings utrymme.In a PowerShell Workflow runbook, an activity, a command, or a script block can have its own runspace. I en PowerShell-runbook körs allt i ett skript i en enda körnings utrymme.In a PowerShell runbook, everything in a script runs in a single runspace. Det finns även vissa syntaktiska skillnader mellan en intern PowerShell-runbook och en PowerShell Workflow-runbook.There are also some syntactic differences between a native PowerShell runbook and a PowerShell Workflow runbook.

Nästa stegNext steps