Azure Automation에 대한 PowerShell 워크플로 학습

아티클
03/20/2024

Azure Automation의 Runbook은 Windows Workflow Foundation을 사용하는 Windows PowerShell 워크플로, Windows PowerShell 스크립트로 구현됩니다. 워크플로는 프로그래밍 방식으로 연결된 단계의 시퀀스로, 장기 실행 작업을 수행하거나 여러 디바이스 또는 관리 노드에서 여러 단계의 조정을 필요로 합니다.

워크플로는 Windows PowerShell 구문으로 작성되고 Windows PowerShell에서 시작되지만 Windows Workflow Foundation에서 처리됩니다. 일반적인 스크립트에 비해 워크플로의 이점은 여러 디바이스에서 작업의 동시 성능 및 오류로부터의 자동 복구를 포함합니다.

참고 항목

이 문서는 PowerShell 5.1에 적용됩니다. PowerShell 7.1(미리 보기) 및 PowerShell 7.2(미리 보기)에서는 워크플로를 지원하지 않습니다. PowerShell 워크플로는 스크립트는 Windows PowerShell 스크립트와 매우 비슷해 보이지만 신규 사용자가 혼동할 수 있는 중요한 차이점이 있습니다. 따라서 검사점을 사용해야 하는 경우에만 PowerShell 워크플로를 사용하여 Runbook을 작성하는 것이 좋습니다.

이 문서의 항목에 대한 자세한 내용은 Windows PowerShell 워크플로 시작을 참조하세요.

워크플로 키워드 사용

PowerShell 스크립트를 PowerShell 워크플로로 변환하는 첫 단계는 Workflow키워드로 둘러싸는 것입니다. 워크플로는 Workflow 키워드와 그 뒤에 중괄호로 묶인 스크립트의 본문으로 시작됩니다. 워크플로 이름은 다음 구문과 같이 Workflow 키워드를 따릅니다.

Workflow Test-Workflow
{
    <Commands>
}

워크플로 이름은 Automation Runbook의 이름과 일치해야 합니다. Runbook을 가져오려면 파일 이름이 워크플로 이름과 일치하고 .ps1로 끝나야 합니다.

워크플로에 매개 변수를 추가하려면, 스크립트와 마찬가지로 Param 키워드를 사용합니다.

PowerShell 워크플로 코드와 PowerShell 스크립트 코드의 차이점 알아보기

PowerShell 워크플로 코드는 몇 가지 중요한 변경 내용을 제외하고는 PowerShell 스크립트 코드와 거의 동일합니다. 다음 섹션에서 설명하는 변경 사항을 사용자가 워크플로에서 실행하려면 PowerShell 스크립트를 만들 필요가 있습니다.

활동

활동은 시퀀스에서 수행되는 워크플로의 특정 작업입니다. Windows PowerShell 워크플로는 워크플로를 실행할 때 자동으로 여러 Windows PowerShell cmdlet을 작업으로 변환합니다. Runbook에서 이러한 cmdlet 중 하나를 지정한 경우 해당 활동은 Windows Workflow Foundation에 의해 실행됩니다.

cmdlet에 해당 활동이 없는 경우 Windows PowerShell 워크플로는 InlineScript 활동 내에서 cmdlet을 자동으로 실행합니다. InlineScript 블록에 명시적으로 포함하지 않으면 일부 cmdlet은 제외되고 워크플로에서 사용할 수 없습니다. 자세한 내용은 스크립트 워크플로에서 활동 사용을 참조하세요.

워크플로 활동은 해당 작업을 구성하기 위해 일반 매개 변수 집합을 공유합니다. about_WorkflowCommonParameters를 참조하세요.

위치 매개 변수

워크플로에서 위치매개 변수는 활동 및 cmdlets와 같이 사용할 수 없습니다. 따라서 매개 변수 이름을 사용해야 합니다. 다음 모든 실행 중인 서비스의 코드를 가져오는 것이 좋습니다.

Get-Service | Where-Object {$_.Status -eq "Running"}

워크플로에서 이 코드를 실행하려고 하는 경우 Parameter set cannot be resolved using the specified named parameters.와 같은 메시지가 표시됩니다. 이 문제를 해결하려면 다음 예제와 같이 매개 변수 이름을 제공합니다.

Workflow Get-RunningServices
{
    Get-Service | Where-Object -FilterScript {$_.Status -eq "Running"}
}

역직렬화된 개체

워크플로의 개체는 역직렬화됩니다. 즉, 해당 속성은 여전히 사용할 수 있지만 메서드는 사용할 수 없습니다. Service 개체의 Stop 메서드를 사용하여 서비스를 중지시키는 다음의 PowerShell 코드를 예로 들 수 있습니다.

$Service = Get-Service -Name MyService
$Service.Stop()

워크플로에서 이를 실행하려고 하면 다음과 같은 오류가 표시됩니다. Method invocation is not supported in a Windows PowerShell Workflow.

한 가지 옵션은 이러한 두 줄의 코드를 InlineScript 블록에 래핑하는 것입니다. 이 경우 Service는 블록 내의 서비스 개체를 나타냅니다.

Workflow Stop-Service
{
    InlineScript {
        $Service = Get-Service -Name MyService
        $Service.Stop()
    }
}

다른 옵션은 하나의 cmdlet이 사용 가능할 경우, 메서드와 동일한 기능이 있는 다른 cmdlet을 사용하는 것입니다. 이 예제에서 Stop-Service cmdlet은 Stop 메서드와 같은 기능을 제공하며 워크플로에 다음 코드를 사용할 수 있습니다.

Workflow Stop-MyService
{
    $Service = Get-Service -Name MyService
    Stop-Service -Name $Service.Name
}

InlineScript 사용

InlineScript 활동은 PowerShell 워크플로 대신 전통적인 PowerShell 스크립트처럼 하나 혹은 그 이상의 명령을 실행해야 할 때 유용합니다. 워크플로의 명령은 처리를 위해 Windows Workflow Foundation으로 보내지만 InlineScript 블록의 명령은 Windows PowerShell에서 처리합니다.

InlineScript에는 아래 표시된 구문이 사용됩니다.

InlineScript
{
    <Script Block>
} <Common Parameters>

출력을 변수에 할당하여 InlineScript에서 출력을 반환 할 수 있습니다. 다음 예제에서는 서비스를 중지하고 서비스 이름을 출력합니다.

Workflow Stop-MyService
{
    $Output = InlineScript {
        $Service = Get-Service -Name MyService
        $Service.Stop()
        $Service
    }

    $Output.Name
}

값을 InlineScript 블록으로 전달할 수 있지만, $Using 범위 한정자를 사용해야 합니다. 다음 예제는 변수에서 제공된 서비스 이름을 제외하고는 이전의 예제와 똑같습니다.

Workflow Stop-MyService
{
    $ServiceName = "MyService"

    $Output = InlineScript {
        $Service = Get-Service -Name $Using:ServiceName
        $Service.Stop()
        $Service
    }

    $Output.Name
}

InlineScript 활동은 특정 워크플로에서 중요할 수 있지만 워크플로 구문은 지원하지 않습니다. 이러한 활동은 다음과 같은 이유로 필요한 경우에만 사용해야 합니다.

InlineScript 블록 내에서는 검사점을 사용할 수 없습니다. 블록 내에서 오류가 발생한 경우 블록의 처음부터 다시 시작해야 합니다.
InlineScript 블록 내에서는 병렬 실행을 사용할 수 없습니다.
InlineScript는 InlineScript 블록의 전체 길이 동안 Windows PowerShell 세션을 유지하므로 워크플로의 확장성에 영향을 줍니다.

InlineScript 사용에 대한 자세한 내용은 워크플로에서 Windows PowerShell 명령 실행 및 about_InlineScript를 참조하세요.

병렬 처리 사용

Windows PowerShell 워크플로의 이점 중 하나는 일반적인 스크립트의 경우와 마찬가지로 명령 집합을 순차적으로 수행하지 않고 병렬로 수행하는 기능입니다.

Parallel 키워드를 사용하여 동시에 실행할 여러 명령이 포함된 스크립트 블록을 만들 수 있습니다. 여기서는 아래 표시된 구문이 사용됩니다. 이 경우에는 Activity1과 Activity2가 동시에 시작됩니다. Activity3는 Activity1과 Activity2가 모두 완료된 후에만 시작됩니다.

Parallel
{
    <Activity1>
    <Activity2>
}
<Activity3>

네트워크 대상에 여러 파일을 복사하는 다음 PowerShell 명령을 예로 들 수 있습니다. 하나의 파일이 복사가 완전히 끝나야만 다음 복사가 시작되므로 이 명령은 순차적으로 실행됩니다.

Copy-Item -Path C:\LocalPath\File1.txt -Destination \\NetworkPath\File1.txt
Copy-Item -Path C:\LocalPath\File2.txt -Destination \\NetworkPath\File2.txt
Copy-Item -Path C:\LocalPath\File3.txt -Destination \\NetworkPath\File3.txt

다음 워크플로는 복사를 동시에 시작하기 때문에 동일한 명령을 병렬로 실행합니다. 복사가 완전히 끝난 후에만 완료 메시지가 표시됩니다.

Workflow Copy-Files
{
    Parallel
    {
        Copy-Item -Path "C:\LocalPath\File1.txt" -Destination "\\NetworkPath"
        Copy-Item -Path "C:\LocalPath\File2.txt" -Destination "\\NetworkPath"
        Copy-Item -Path "C:\LocalPath\File3.txt" -Destination "\\NetworkPath"
    }

    Write-Output "Files copied."
}

ForEach -Parallel 구문을 사용하여 컬렉션의 각 항목에 대한 명령을 동시에 처리할 수 있습니다. 이 경우 컬렉션의 항목은 병렬로 처리되지만 스크립트 블록의 명령은 순차적으로 실행됩니다. 이 프로세스는 아래와 같은 구문을 사용합니다. 이 예제에서 Activity1은 컬렉션의 모든 항목에 대해 동시에 시작됩니다. 각 항목에 대해 Activity2는 Activity1이 완료된 후에 시작됩니다. Activity3는 모든 항목에 대해 Activity1과 Activity2가 모두 완료된 후에만 시작됩니다. ThrottleLimit 매개 변수를 사용하여 병렬 처리를 제한합니다. ThrottleLimit이 너무 크면 문제가 발생할 수 있습니다. ThrottleLimit 매개 변수의 적절한 값은 사용자 환경의 여러 요인에 따라 달라집니다. 특정 상황에서 적합한 값을 찾을 때까지 낮은 값부터 서서히 늘려가면서 시도합니다.

ForEach -Parallel -ThrottleLimit 10 ($<item> in $<collection>)
{
    <Activity1>
    <Activity2>
}
<Activity3>

다음 예제에서는 동시에 파일을 복사하는 이전 예제와 비슷합니다. 이 경우 복사한 후 각 파일에 대 한 메시지가 표시 됩니다. 복사가 완전히 끝난 후에만 마지막 완료 메시지가 표시됩니다.

Workflow Copy-Files
{
    $files = @("C:\LocalPath\File1.txt","C:\LocalPath\File2.txt","C:\LocalPath\File3.txt")

    ForEach -Parallel -ThrottleLimit 10 ($File in $Files)
    {
        Copy-Item -Path $File -Destination \\NetworkPath
        Write-Output "$File copied."
    }

    Write-Output "All files copied."
}

참고 항목

자식 runbook을 병렬로 실행하는 것은 추천하지 않는 이유는 결과물이 신뢰할 수 없기 때문입니다. 자식 Runbook에서의 출력은 때때로 나타나지 않을 수도 있고, 한 자식 Runbook의 설정이 다른 병렬 자식 Runbook에 영향을 미칠 수 있습니다. VerbosePreference, WarningPreference 등의 변수는 자식 Runbook으로 전파되지 않을 수 있습니다. 자식 Runbook이 이러한 값을 변경하는 경우 호출 후 제대로 복원될 수 없습니다.

워크플로에서 검사점 사용

검사점은 워크플로의 현재 상태에 대한 스냅샷으로, 변수의 현재 값 및 해당 지점에 생성된 모든 출력을 포함합니다. 워크플로가 오류로 종료되거나 일시 중단된 경우 처음부터 시작하는 대신 다음에 실행될 때 마지막 검사점부터 시작됩니다.

Checkpoint-Workflow 활동을 사용하여 워크플로에서 검사점을 설정할 수 있습니다. Azure Automation에는 3시간 동안 실행되는 모든 Runbook이 언로드되고 다른 Runbook이 실행될 수 있도록 공평 분배라는 기능이 있습니다. 결국 언로드된 Runbook이 다시 로드됩니다. 이 경우 Runbook에서 수행된 마지막 검사점에서 실행이 다시 시작됩니다.

Runbook이 최종적으로 완료되도록 하려면 3시간 미만 동안 실행되는 간격에 검사점을 추가해야 합니다. 각 실행 중에 새 검사점이 추가되고, 오류로 인해 3시간 후에 Runbook이 제거되면 Runbook은 무기한 다시 시작됩니다.

다음 예제에서는 Activity2 이후에 예외가 발생하여 워크플로가 끝납니다. 이 활동은 설정된 마지막 검사점 직후이므로 워크플로를 다시 시작하면 Activity2를 실행하는 것으로 작업이 시작됩니다.

<Activity1>
Checkpoint-Workflow
<Activity2>
<Exception>
<Activity3>

예외가 발생할 수 있으며 워크플로를 다시 시작한 경우 반복되지 않아야 하는 활동 뒤에 워크플로의 검사점을 설정합니다. 예를 들어 Runbook에서 가상 머신을 만들 수 있습니다. 가상 머신을 만드는 명령 앞뒤 모두에 검사점을 설정할 수 있습니다. 만들기에 실패하면, 워크플로가 다시 시작하는 경우 명령을 반복합니다. 생성 후 워크플로가 실패하는 경우 워크플로를 재시작할 때에도 가상 머신은 다시 생성되지 않습니다.

다음 예제는 네트워크 위치에 여러 파일들을 복사하고 각 파일에 검사점을 설정합니다. 네트워크 위치가 손실된 경우 워크플로가 오류로 종료됩니다. 다시 시작되면 마지막 검사점에서 다시 시작됩니다. 이미 복사된 파일만 건너뜁니다.

Workflow Copy-Files
{
    $files = @("C:\LocalPath\File1.txt","C:\LocalPath\File2.txt","C:\LocalPath\File3.txt")

    ForEach ($File in $Files)
    {
        Copy-Item -Path $File -Destination \\NetworkPath
        Write-Output "$File copied."
        Checkpoint-Workflow
    }

    Write-Output "All files copied."
}

Suspend-workflow 작업을 호출한 후 또는 마지막 검사점 이후에 사용자 이름 자격 증명을 유지하지 않기 때문에 자격 증명을 Null로 설정하고 Suspend-Workflow 또는 검사점을 호출한 후에 자산 저장소에서 다시 검색해야 합니다. 그렇지 않으면 다음 오류 메시지가 표시될 수 있습니다. The workflow job cannot be resumed, either because persistence data could not be saved completely, or saved persistence data has been corrupted. You must restart the workflow.

다음과 같은 코드에서는 PowerShell 워크플로 Runbook에서 이 상황을 처리하는 방법을 보여 줍니다.

workflow CreateTestVms
{
    $Cred = Get-AzAutomationCredential -Name "MyCredential"
    $null = Connect-AzAccount -Credential $Cred

    $VmsToCreate = Get-AzAutomationVariable -Name "VmsToCreate"

    foreach ($VmName in $VmsToCreate)
        {
        # Do work first to create the VM (code not shown)

        # Now add the VM
        New-AzVM -VM $Vm -Location "WestUs" -ResourceGroupName "ResourceGroup01"

        # Checkpoint so that VM creation is not repeated if workflow suspends
        $Cred = $null
        Checkpoint-Workflow
        $Cred = Get-AzAutomationCredential -Name "MyCredential"
        $null = Connect-AzAccount -Credential $Cred
        }
}

참고 항목

비그래픽 PowerShell Runbook의 경우 Add-AzAccount 및 Add-AzureRMAccount는 Connect-AzAccount에 대한 별칭입니다. 이러한 cmdlet을 사용하거나 Automation 계정의 모듈을 최신 버전으로 업데이트할 수 있습니다. 새 Automation 계정을 만든 경우에도 모듈을 업데이트해야 할 수 있습니다.

검사점에 대한 자세한 내용은 스크립트 워크플로에 검사점 추가를 참조하세요.

다음 단계

PowerShell 워크플로 Runbook에 대해 알아보려면 자습서: PowerShell 워크플로 Runbook 만들기를 참조하세요.

Azure Automation에 대한 PowerShell 워크플로 학습

워크플로 키워드 사용

PowerShell 워크플로 코드와 PowerShell 스크립트 코드의 차이점 알아보기

활동

위치 매개 변수

역직렬화된 개체

InlineScript 사용

병렬 처리 사용

워크플로에서 검사점 사용

다음 단계

추가 리소스