Get content of a draft runbook

The Get content of draft runbook operation returns the content of a runbook draft.

Use the Get content of a published runbook operation to get the content of a published runbook.

Request

To specify the request, replace <subscription-id> with your subscription ID, <cloud-service-name> with the name of the cloud service to use for making the request, <automation-account-name> with the name of the automation account to use for making the request, and <runbook-name> with the name of the draft runbook to get content from. Include required URI parameters.

URI Parameters

Request Headers

The request header in the following table is required.

Request Body

None

Response

Status Code

A successful operation returns 200 (OK). For information about common error codes, see HTTP/1.1 Status Code Definitions.

Response Headers

Response Body

The runbook is provided after the response headers with the content type of text/powershell, as shown in the following example:

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 5286
Content-Type: text/powershell
Expires: -1
ETag: "635657056882600000"
Vary: Accept-Encoding
Server: 1.0.6198.202 (rd_rdfe_stable.150307-1902) Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000; includeSubDomains,max-age=31536000; includeSubDomains
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET,ASP.NET
x-ms-request-id: 5b054afd3bc02ce1925af4c643a9af8c
Date: Mon, 27 Apr 2015 04:39:44 GMT

<#
.SYNOPSIS 
    Copies a file to an Azure VM.

.DESCRIPTION
    This runbook copies a local file to an Azure virtual machine.
    Connect-AzureVM must be imported and published in order for this runbook to work. The Connect-AzureVM
runbook sets up the connection to the virtual machine where the local file will be copied to.  

When using this runbook, be aware that the memory and disk space size of the processes running your
runbooks is limited. Because of this, we recommened only using runbooks to transfer small files.
All Automation Integration Module assets in your account are loaded into your processes,
so be aware that the more Integration Modules you have in your system, the smaller the free space in
your processes will be. To ensure maximum disk space in your processes, make sure to clean up any local
files a runbook transfers or creates in the process before the runbook completes.

.PARAMETER AzureSubscriptionName
    Name of the Azure subscription to connect to

.PARAMETER AzureOrgIdCredential
    A credential containing an Org Id username / password with access to this Azure subscription.

If invoking this runbook inline from within another runbook, pass a PSCredential for this parameter.

If starting this runbook using Start-AzureAutomationRunbook, or via the Azure classic portal UI, pass as a string the
name of an Azure Automation PSCredential asset instead. Azure Automation will automatically grab the asset with
that name and pass it into the runbook.

.PARAMETER ServiceName
    Name of the cloud service where the VM is located.

.PARAMETER VMName    
    Name of the virtual machine that you want to connect to.  

.PARAMETER VMCredentialName
    Name of a PowerShell credential asset that is stored in the Automation service.
    This credential should have access to the virtual machine.

.PARAMETER LocalPath
    The local path to the item to copy to the Azure virtual machine.

.PARAMETER RemotePath
    The remote path on the Azure virtual machine where the item should be copied to.

.EXAMPLE
    Copy-ItemToAzureVM -AzureSubscriptionName "Visual Studio Ultimate with MSDN" -ServiceName "myService" -VMName "myVM" -VMCredentialName "myVMCred" -LocalPath ".\myFile.txt" -RemotePath "C:\Users\username\myFileCopy.txt" -AzureOrgIdCredential $cred

.NOTES
    AUTHOR: System Center Automation Team
    LASTEDIT: Apr 26, 2015  
#>
workflow Copy-ItemToAzureVM {
    param
    (
        [parameter(Mandatory=$true)]
        [String]
        $AzureSubscriptionName,

[parameter(Mandatory=$true)]
        [PSCredential]
        $AzureOrgIdCredential,

        [parameter(Mandatory=$true)]
        [String]
        $ServiceName,

        [parameter(Mandatory=$true)]
        [String]
        $VMName,  

        [parameter(Mandatory=$true)]
        [String]
        $VMCredentialName,

        [parameter(Mandatory=$true)]
        [String]
        $LocalPath,

        [parameter(Mandatory=$true)]
        [String]
        $RemotePath  
    )

    # Get credentials to Azure VM
    $Credential = Get-AutomationPSCredential -Name $VMCredentialName    
if ($Credential -eq $null)
    {
        throw "Could not retrieve '$VMCredentialName' credential asset. Check that you created this asset in the Automation service."
    }     

# Set up the Azure VM connection by calling the Connect-AzureVM runbook. You should call this runbook after
# every CheckPoint-WorkFlow in your runbook to ensure that the connection to the Azure VM is restablished if this runbook
# gets interrupted and starts from the last checkpoint.
    $Uri = Connect-AzureVM -AzureSubscriptionName $AzureSubscriptionName -AzureOrgIdCredential $AzureOrgIdCredential –ServiceName $ServiceName –VMName $VMName

    # Store the file contents on the Azure VM
    InlineScript {
        $ConfigurationName = "HighDataLimits"

        # Enable larger data to be sent
        Invoke-Command -ScriptBlock {
            $ConfigurationName = $args[0]
            $Session = Get-PSSessionConfiguration -Name $ConfigurationName

            if(!$Session) {
                Write-Verbose "Large data sending is not allowed. Creating PSSessionConfiguration $ConfigurationName"

                Register-PSSessionConfiguration -Name $ConfigurationName -MaximumReceivedDataSizePerCommandMB 500 -MaximumReceivedObjectSizeMB 500 -Force | Out-Null
            }
        } -ArgumentList $ConfigurationName -ConnectionUri $Using:Uri -Credential $Using:Credential -ErrorAction SilentlyContinue     

        # Get the file contents locally
        $Content = Get-Content –Path $Using:LocalPath –Encoding Byte

        Write-Verbose ("Retrieved local content from $Using:LocalPath")

        Invoke-Command -ScriptBlock {
            param($Content, $RemotePath)

$Content | Set-Content –Path $RemotePath -Encoding Byte
        } -ArgumentList $Content, $Using:RemotePath -ConnectionUri $Using:Uri -Credential $Using:Credential -ConfigurationName $ConfigurationName

        Write-Verbose ("Wrote content from $Using:LocalPath to $Using:VMName at $Using:RemotePath")
    }
}

See Also

Automation Runbooks
Operations on Automation