Runbook - Update
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 |
---|---|---|---|---|
subscription
|
path | True |
|
Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resource
|
path | True |
|
Name of an Azure Resource group. Regex pattern: |
automation
|
path | True |
|
The name of the automation account. |
runbook
|
path | True |
|
The runbook name. |
api-version
|
query | True |
|
Client Api Version. |
Request Body
Name | Type | Description |
---|---|---|
location |
|
Gets or sets the location of the resource. |
name |
|
Gets or sets the name of the resource. |
properties.description |
|
Gets or sets the description of the runbook. |
properties.logActivityTrace |
|
Gets or sets the activity-level tracing options of the runbook. |
properties.logProgress |
|
Gets or sets progress log option. |
properties.logVerbose |
|
Gets or sets verbose log option. |
tags |
|
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
{
"properties": {
"description": "Updated Description of the Runbook",
"logVerbose": false,
"logProgress": true,
"logActivityTrace": 1
}
}
Sample Response
Definitions
Content |
Definition of the runbook property type. |
Content |
Definition of the content link. |
Error |
Error response of an operation failure |
Runbook |
Definition of the runbook type. |
Runbook |
|
Runbook |
Definition of the runbook parameter type. |
Runbook |
Gets or sets the provisioning state of the runbook. |
Runbook |
Gets or sets the state of the runbook. |
Runbook |
Gets or sets the type of the runbook. |
Runbook |
The parameters supplied to the update runbook operation. |
ContentHash
Definition of the runbook property type.
Name | Type | Description |
---|---|---|
algorithm |
|
Gets or sets the content hash algorithm used to hash the content. |
value |
|
Gets or sets expected hash value of the content. |
ContentLink
Definition of the content link.
Name | Type | Description |
---|---|---|
contentHash |
Gets or sets the hash. |
|
uri |
|
Gets or sets the uri of the runbook content. |
version |
|
Gets or sets the version of the content. |
ErrorResponse
Error response of an operation failure
Name | Type | Description |
---|---|---|
code |
|
Error code |
message |
|
Error message indicating why the operation failed. |
Runbook
Definition of the runbook type.
Name | Type | Description |
---|---|---|
etag |
|
Gets or sets the etag of the resource. |
id |
|
Fully qualified resource Id for the resource |
location |
|
The Azure Region where the resource lives |
name |
|
The name of the resource |
properties.creationTime |
|
Gets or sets the creation time. |
properties.description |
|
Gets or sets the description. |
properties.draft |
Gets or sets the draft runbook properties. |
|
properties.jobCount |
|
Gets or sets the job count of the runbook. |
properties.lastModifiedBy |
|
Gets or sets the last modified by. |
properties.lastModifiedTime |
|
Gets or sets the last modified time. |
properties.logActivityTrace |
|
Gets or sets the option to log activity trace of the runbook. |
properties.logProgress |
|
Gets or sets progress log option. |
properties.logVerbose |
|
Gets or sets verbose log option. |
properties.outputTypes |
|
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 |
|
Resource tags. |
type |
|
The type of the resource. |
RunbookDraft
Name | Type | Description |
---|---|---|
creationTime |
|
Gets or sets the creation time of the runbook draft. |
draftContentLink |
Gets or sets the draft runbook content link. |
|
inEdit |
|
Gets or sets whether runbook is in edit mode. |
lastModifiedTime |
|
Gets or sets the last modified time of the runbook draft. |
outputTypes |
|
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 |
|
Gets or sets the default value of parameter. |
isMandatory |
|
Gets or sets a Boolean value to indicate whether the parameter is mandatory or not. |
position |
|
Get or sets the position of the parameter. |
type |
|
Gets or sets the type of the parameter. |
RunbookProvisioningState
Gets or sets the provisioning state of the runbook.
Name | Type | Description |
---|---|---|
Succeeded |
|
RunbookState
Gets or sets the state of the runbook.
Name | Type | Description |
---|---|---|
Edit |
|
|
New |
|
|
Published |
|
RunbookTypeEnum
Gets or sets the type of the runbook.
Name | Type | Description |
---|---|---|
Graph |
|
|
GraphPowerShell |
|
|
GraphPowerShellWorkflow |
|
|
PowerShell |
|
|
PowerShellWorkflow |
|
|
Script |
|
RunbookUpdateParameters
The parameters supplied to the update runbook operation.
Name | Type | Description |
---|---|---|
location |
|
Gets or sets the location of the resource. |
name |
|
Gets or sets the name of the resource. |
properties.description |
|
Gets or sets the description of the runbook. |
properties.logActivityTrace |
|
Gets or sets the activity-level tracing options of the runbook. |
properties.logProgress |
|
Gets or sets progress log option. |
properties.logVerbose |
|
Gets or sets verbose log option. |
tags |
|
Gets or sets the tags attached to the resource. |