你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Runbook - Update

Service:

Automation

API Version:

2023-11-01

更新由 Runbook 名称标识的 Runbook。

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

URI 参数

名称	在	必需	类型	说明
automationAccountName	path	True	string	自动化帐户的名称。
resourceGroupName	path	True	string	Azure 资源组的名称。 Regex pattern: ^[-\w\._]+$
runbookName	path	True	string	Runbook 名称。 Regex pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
subscriptionId	path	True	string	获取唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
location	string	获取或设置资源的位置。
name	string	获取或设置资源的名称。
properties.description	string	获取或设置 Runbook 的说明。
properties.logActivityTrace	integer	获取或设置 Runbook 的活动级跟踪选项。
properties.logProgress	boolean	获取或设置进度日志选项。
properties.logVerbose	boolean	获取或设置详细日志选项。
tags	object	获取或设置附加到资源的标记。

响应

名称	类型	说明
200 OK	Runbook	确定
Other Status Codes	ErrorResponse	描述操作失败原因的自动化错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Update runbook

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2023-11-01

{
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636265044994500000\"",
  "properties": {
    "description": "Updated Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-30T21:01:33.777+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-30T21:01:39.45+00:00"
  }
}

定义

名称	说明
ContentHash	Runbook 属性类型的定义。
ContentLink	内容链接的定义。
ErrorResponse	操作失败的错误响应
Runbook	Runbook 类型的定义。
RunbookDraft
RunbookParameter	Runbook 参数类型的定义。
RunbookProvisioningState	获取或设置 Runbook 的预配状态。
RunbookState	获取或设置 Runbook 的状态。
RunbookTypeEnum	获取或设置 Runbook 的类型。
RunbookUpdateParameters	提供给更新 Runbook 操作的参数。

ContentHash

Runbook 属性类型的定义。

名称	类型	说明
algorithm	string	获取或设置用于对内容进行哈希处理的内容哈希算法。
value	string	获取或设置内容的预期哈希值。

ContentLink

内容链接的定义。

名称	类型	说明
contentHash	ContentHash	设置哈希。
uri	string	设置内容的 URI。
version	string	设置内容的版本。

ErrorResponse

操作失败的错误响应

名称	类型	说明
code	string	错误代码
message	string	指示操作失败原因的错误消息。

Runbook

Runbook 类型的定义。

名称	类型	说明
etag	string	获取或设置资源的 etag。
id	string	资源的完全限定资源 ID
location	string	资源所在的 Azure 区域
name	string	资源的名称
properties.creationTime	string	获取或设置创建时间。
properties.description	string	获取或设置说明。
properties.draft	RunbookDraft	获取或设置草稿 Runbook 属性。
properties.jobCount	integer	获取或设置 Runbook 的作业计数。
properties.lastModifiedBy	string	获取或设置上次修改者。
properties.lastModifiedTime	string	获取或设置上次修改时间。
properties.logActivityTrace	integer	获取或设置用于记录 Runbook 的活动跟踪的选项。
properties.logProgress	boolean	获取或设置进度日志选项。
properties.logVerbose	boolean	获取或设置详细日志选项。
properties.outputTypes	string[]	获取或设置 Runbook 输出类型。
properties.parameters	<string,  RunbookParameter>	获取或设置 Runbook 参数。
properties.provisioningState	RunbookProvisioningState	获取或设置 Runbook 的预配状态。
properties.publishContentLink	ContentLink	获取或设置已发布的 Runbook 内容链接。
properties.runbookType	RunbookTypeEnum	获取或设置 Runbook 的类型。
properties.state	RunbookState	获取或设置 Runbook 的状态。
tags	object	资源标记。
type	string	资源类型。

RunbookDraft

名称	类型	说明
creationTime	string	获取或设置 Runbook 草稿的创建时间。
draftContentLink	ContentLink	获取或设置草稿 Runbook 内容链接。
inEdit	boolean	获取或设置 Runbook 是否处于编辑模式。
lastModifiedTime	string	获取或设置 Runbook 草稿的上次修改时间。
outputTypes	string[]	获取或设置 Runbook 输出类型。
parameters	<string,  RunbookParameter>	获取或设置 Runbook 草稿参数。

RunbookParameter

Runbook 参数类型的定义。

名称	类型	说明
defaultValue	string	获取或设置参数的默认值。
isMandatory	boolean	获取或设置一个布尔值，该值指示参数是否为必需参数。
position	integer	获取或设置参数的位置。
type	string	获取或设置参数的类型。

RunbookProvisioningState

获取或设置 Runbook 的预配状态。

名称	类型	说明
Succeeded	string

RunbookState

获取或设置 Runbook 的状态。

名称	类型	说明
Edit	string
New	string
Published	string

RunbookTypeEnum

获取或设置 Runbook 的类型。

名称	类型	说明
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

RunbookUpdateParameters

提供给更新 Runbook 操作的参数。

名称	类型	说明
location	string	获取或设置资源的位置。
name	string	获取或设置资源的名称。
properties.description	string	获取或设置 Runbook 的说明。
properties.logActivityTrace	integer	获取或设置 Runbook 的活动级跟踪选项。
properties.logProgress	boolean	获取或设置进度日志选项。
properties.logVerbose	boolean	获取或设置详细日志选项。
tags	object	获取或设置附加到资源的标记。