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

Runbook - Create Or Update

服务:: Automation

API 版本:: 2024-10-23

创建 Runbook 名称标识的 Runbook。

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

URI 参数

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

请求正文

名称	必需	类型	说明
properties.runbookType	True	RunbookTypeEnum	获取或设置 Runbook 的类型。
location		string	获取或设置资源的位置。
name		string	获取或设置资源的名称。
properties.description		string	获取或设置 Runbook 的说明。
properties.draft		RunbookDraft	获取或设置草稿 Runbook 属性。
properties.logActivityTrace		integer (int32)	获取或设置 Runbook 的活动级跟踪选项。
properties.logProgress		boolean	获取或设置进度日志选项。
properties.logVerbose		boolean	获取或设置详细日志选项。
properties.publishContentLink		ContentLink	获取或设置已发布的 Runbook 内容链接。
properties.runtimeEnvironment		string	Runbook 的环境。
tags		object	获取或设置附加到资源的标记。

响应

名称	类型	说明
200 OK	Runbook	好的
201 Created	Runbook	已创建
Other Status Codes	ErrorResponse	描述操作失败原因的自动化错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create or update runbook and publish it

Create runbook as draft

Create or update runbook and publish it

示例请求

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2024-10-23

{
  "properties": {
    "logVerbose": false,
    "logProgress": true,
    "runbookType": "PowerShell",
    "runtimeEnvironment": "environmentName",
    "publishContentLink": {
      "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
      "contentHash": {
        "algorithm": "SHA256",
        "value": "115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80"
      }
    },
    "description": "Description of the Runbook",
    "logActivityTrace": 1
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

示例响应

状态代码:: 201

{
  "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": "\"636263318837230000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShell",
    "runtimeEnvironment": "environmentName",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:43.723+00:00"
  }
}

状态代码:: 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": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": true,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "runtimeEnvironment": "environmentName",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:46.6+00:00"
  }
}

Create runbook as draft

示例请求

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2024-10-23

{
  "properties": {
    "logVerbose": false,
    "logProgress": false,
    "runbookType": "PowerShell",
    "runtimeEnvironment": "environmentName",
    "description": "Description of the Runbook",
    "draft": {}
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

示例响应

状态代码:: 201

{
  "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": "\"636263318837230000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "parameters": {},
    "runbookType": "PowerShell",
    "runtimeEnvironment": "environmentName",
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00",
    "outputTypes": []
  }
}

状态代码:: 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": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "parameters": {},
    "runbookType": "PowerShell",
    "runtimeEnvironment": "environmentName",
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00"
  }
}

定义

名称	说明
ContentHash	Runbook 属性类型的定义。
ContentLink	内容链接的定义。
createdByType	创建资源的标识的类型。
ErrorResponse	操作失败的错误响应
Runbook	Runbook 类型的定义。
RunbookCreateOrUpdateParameters	提供给创建或更新 Runbook作的参数。
RunbookDraft
RunbookParameter	Runbook 参数类型的定义。
RunbookProvisioningState	获取或设置 Runbook 的预配状态。
RunbookState	获取或设置 Runbook 的状态。
RunbookTypeEnum	获取或设置 Runbook 的类型。
systemData	与创建和上次修改资源相关的元数据。

ContentHash

Object

Runbook 属性类型的定义。

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

ContentLink

Object

内容链接的定义。

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

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorResponse

Object

操作失败的错误响应

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

Runbook

Object

Runbook 类型的定义。

名称	类型	说明
etag	string	获取或设置资源的 etag。
id	string (arm-id)	资源的完全限定的资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.creationTime	string (date-time)	获取或设置创建时间。
properties.description	string	获取或设置说明。
properties.draft	RunbookDraft	获取或设置草稿 Runbook 属性。
properties.jobCount	integer (int32)	获取或设置 Runbook 的作业计数。
properties.lastModifiedBy	string	获取或设置上次修改者。
properties.lastModifiedTime	string (date-time)	获取或设置上次修改时间。
properties.logActivityTrace	integer (int32)	获取或设置用于记录 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.runtimeEnvironment	string	Runbook 执行的运行时环境。
properties.state	RunbookState	获取或设置 Runbook 的状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

RunbookCreateOrUpdateParameters

Object

提供给创建或更新 Runbook作的参数。

名称	类型	说明
location	string	获取或设置资源的位置。
name	string	获取或设置资源的名称。
properties.description	string	获取或设置 Runbook 的说明。
properties.draft	RunbookDraft	获取或设置草稿 Runbook 属性。
properties.logActivityTrace	integer (int32)	获取或设置 Runbook 的活动级跟踪选项。
properties.logProgress	boolean	获取或设置进度日志选项。
properties.logVerbose	boolean	获取或设置详细日志选项。
properties.publishContentLink	ContentLink	获取或设置已发布的 Runbook 内容链接。
properties.runbookType	RunbookTypeEnum	获取或设置 Runbook 的类型。
properties.runtimeEnvironment	string	Runbook 的环境。
tags	object	获取或设置附加到资源的标记。

RunbookDraft

Object

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

RunbookParameter

Object

Runbook 参数类型的定义。

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

RunbookProvisioningState

枚举

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

值	说明
Succeeded

RunbookState

枚举

获取或设置 Runbook 的状态。

值	说明
New
Edit
Published

RunbookTypeEnum

枚举

获取或设置 Runbook 的类型。

值	说明
Script
Graph
PowerShellWorkflow
PowerShell
GraphPowerShellWorkflow
GraphPowerShell
Python2
Python3
Python
PowerShell72

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Runbook - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Create or update runbook and publish it

示例请求

示例响应

Create runbook as draft

示例请求

示例响应

定义

ContentHash

ContentLink

createdByType

ErrorResponse

Runbook

RunbookCreateOrUpdateParameters

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

systemData