Runbook - Update

Service:
Automation
API Version:
2015-10-31

Update the runbook identified by runbook name.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}?api-version=2015-10-31

URI Parameters

Name In Required Type Description
subscriptionId
 path True
  • string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
resourceGroupName
 path True
  • string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$
automationAccountName
 path True
  • string

The name of the automation account.
runbookName
 path True
  • string

The runbook name.
api-version
 query True
  • string

Client Api Version.

Request Body

Name Type Description
location
  • string

Gets or sets the location of the resource.
name
  • string

Gets or sets the name of the resource.
properties.description
  • string

Gets or sets the description of the runbook.
properties.logActivityTrace
  • integer

Gets or sets the activity-level tracing options of the runbook.
properties.logProgress
  • boolean

Gets or sets progress log option.
properties.logVerbose
  • boolean

Gets or sets verbose log option.
tags
  • object

Gets or sets the tags attached to the resource.

Responses

Name Type Description
200 OK

OK
Other Status Codes

Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Update runbook

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2015-10-31
Request Body
{
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1
  }
}

Sample Response

Status code:
200

Definitions

ContentHash

Definition of the runbook property type.
ContentLink

Definition of the content link.
ErrorResponse

Error response of an operation failure
Runbook

Definition of the runbook type.
RunbookDraft
RunbookParameter

Definition of the runbook parameter type.
RunbookProvisioningState

Gets or sets the provisioning state of the runbook.
RunbookState

Gets or sets the state of the runbook.
RunbookTypeEnum

Gets or sets the type of the runbook.
RunbookUpdateParameters

The parameters supplied to the update runbook operation.

ContentHash

Definition of the runbook property type.

Name Type Description
algorithm
  • string

Gets or sets the content hash algorithm used to hash the content.
value
  • string

Gets or sets expected hash value of the content.

Definition of the content link.

Name Type Description
contentHash

Gets or sets the hash.
uri
  • string

Gets or sets the uri of the runbook content.
version
  • string

Gets or sets the version of the content.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code
message
  • string

Error message indicating why the operation failed.

Runbook

Definition of the runbook type.

Name Type Description
etag
  • string

Gets or sets the etag of the resource.
id
  • string

Fully qualified resource Id for the resource
location
  • string

The Azure Region where the resource lives
name
  • string

The name of the resource
properties.creationTime
  • string

Gets or sets the creation time.
properties.description
  • string

Gets or sets the description.
properties.draft

Gets or sets the draft runbook properties.
properties.jobCount
  • integer

Gets or sets the job count of the runbook.
properties.lastModifiedBy
  • string

Gets or sets the last modified by.
properties.lastModifiedTime
  • string

Gets or sets the last modified time.
properties.logActivityTrace
  • integer

Gets or sets the option to log activity trace of the runbook.
properties.logProgress
  • boolean

Gets or sets progress log option.
properties.logVerbose
  • boolean

Gets or sets verbose log option.
properties.outputTypes
  • string[]

Gets or sets the runbook output types.
properties.parameters

Gets or sets the runbook parameters.
properties.provisioningState

Gets or sets the provisioning state of the runbook.
properties.publishContentLink

Gets or sets the published runbook content link.
properties.runbookType

Gets or sets the type of the runbook.
properties.state

Gets or sets the state of the runbook.
tags
  • object

Resource tags.
type
  • string

The type of the resource.

RunbookDraft

Name Type Description
creationTime
  • string

Gets or sets the creation time of the runbook draft.
draftContentLink

Gets or sets the draft runbook content link.
inEdit
  • boolean

Gets or sets whether runbook is in edit mode.
lastModifiedTime
  • string

Gets or sets the last modified time of the runbook draft.
outputTypes
  • string[]

Gets or sets the runbook output types.
parameters

Gets or sets the runbook draft parameters.

RunbookParameter

Definition of the runbook parameter type.

Name Type Description
defaultValue
  • string

Gets or sets the default value of parameter.
isMandatory
  • boolean

Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
position
  • integer

Get or sets the position of the parameter.
type
  • string

Gets or sets the type of the parameter.

RunbookProvisioningState

Gets or sets the provisioning state of the runbook.

Name Type Description
Succeeded
  • string

RunbookState

Gets or sets the state of the runbook.

Name Type Description
Edit
  • string
New
  • string
Published
  • string

RunbookTypeEnum

Gets or sets the type of the runbook.

Name Type Description
Graph
  • string
GraphPowerShell
  • string
GraphPowerShellWorkflow
  • string
PowerShell
  • string
PowerShellWorkflow
  • string
Script
  • string

RunbookUpdateParameters

The parameters supplied to the update runbook operation.

Name Type Description
location
  • string

Gets or sets the location of the resource.
name
  • string

Gets or sets the name of the resource.
properties.description
  • string

Gets or sets the description of the runbook.
properties.logActivityTrace
  • integer

Gets or sets the activity-level tracing options of the runbook.
properties.logProgress
  • boolean

Gets or sets progress log option.
properties.logVerbose
  • boolean

Gets or sets verbose log option.
tags
  • object

Gets or sets the tags attached to the resource.