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

Microsoft.Automation automationAccounts/runbooks

项目
12/16/2024

Bicep 资源定义

可以使用目标操作部署 automationAccounts/runbook 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Automation/automationAccounts/runbook 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2024-10-23' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    draft: {
      creationTime: 'string'
      draftContentLink: {
        contentHash: {
          algorithm: 'string'
          value: 'string'
        }
        uri: 'string'
        version: 'string'
      }
      inEdit: bool
      lastModifiedTime: 'string'
      outputTypes: [
        'string'
      ]
      parameters: {
        {customized property}: {
          defaultValue: 'string'
          isMandatory: bool
          position: int
          type: 'string'
        }
      }
    }
    logActivityTrace: int
    logProgress: bool
    logVerbose: bool
    publishContentLink: {
      contentHash: {
        algorithm: 'string'
        value: 'string'
      }
      uri: 'string'
      version: 'string'
    }
    runbookType: 'string'
    runtimeEnvironment: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ContentHash

名字	描述	价值
算法	获取或设置用于对内容进行哈希处理的内容哈希算法。	string （必需）
价值	获取或设置内容的预期哈希值。	string （必需）

ContentLink

名字	描述	价值
contentHash	获取或设置哈希。	ContentHash
uri	获取或设置内容的 URI。	字符串
版本	获取或设置内容的版本。	字符串

Microsoft.Automation/automationAccounts/runbooks

名字	描述	价值
位置	获取或设置资源的位置。	字符串
名字	资源名称	字符串约束：模式 = `^[a-zA-Z][a-zA-Z-_0-9]*$` （必需）
父母	在 Bicep 中，可以为子资源指定父资源。仅当子资源在父资源外部声明时，才需要添加此属性。有关详细信息，请参阅父资源外部的子资源。	类型资源的符号名称：automationAccounts
性能	获取或设置 Runbook 创建或更新属性。	RunbookCreateOrUpdatePropertiesOrRunbookProperties（必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

RunbookCreateOrUpdateParametersTags

名字	描述	价值

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名字	描述	价值
描述	获取或设置 Runbook 的说明。	字符串
草案	获取或设置草稿 Runbook 属性。	RunbookDraft
logActivityTrace	获取或设置 Runbook 的活动级跟踪选项。	int
logProgress	获取或设置进度日志选项。	bool
logVerbose	获取或设置详细日志选项。	bool
publishContentLink	获取或设置已发布的 Runbook 内容链接。	ContentLink
runbookType	获取或设置 Runbook 的类型。	“Graph” “GraphPowerShell” “GraphPowerShellWorkflow” “PowerShell” “PowerShell72” “PowerShellWorkflow” “Python” “Python2” “Python3” “Script”（必需）
runtimeEnvironment	Runbook 的环境。	字符串

RunbookDraft

名字	描述	价值
creationTime	获取或设置 Runbook 草稿的创建时间。	字符串
draftContentLink	获取或设置草稿 Runbook 内容链接。	ContentLink
inEdit	获取或设置 Runbook 是否处于编辑模式。	bool
lastModifiedTime	获取或设置 Runbook 草稿的上次修改时间。	字符串
outputTypes	获取或设置 Runbook 输出类型。	string[]
参数	获取或设置 Runbook 草稿参数。	RunbookDraftParameters

RunbookDraftParameters

名字	描述	价值

RunbookParameter

名字	描述	价值
defaultValue	获取或设置参数的默认值。	字符串
isMandatory	获取或设置一个布尔值，该值指示参数是否是必需的。	bool
位置	获取或设置参数的位置。	int
类型	获取或设置参数的类型。	字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
ASR Runbook	为 ASR 恢复计划部署自动化 Runbook

ARM 模板资源定义

可以使用目标操作部署 automationAccounts/runbook 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Automation/automationAccounts/runbooks 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2024-10-23",
  "name": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "draft": {
      "creationTime": "string",
      "draftContentLink": {
        "contentHash": {
          "algorithm": "string",
          "value": "string"
        },
        "uri": "string",
        "version": "string"
      },
      "inEdit": "bool",
      "lastModifiedTime": "string",
      "outputTypes": [ "string" ],
      "parameters": {
        "{customized property}": {
          "defaultValue": "string",
          "isMandatory": "bool",
          "position": "int",
          "type": "string"
        }
      }
    },
    "logActivityTrace": "int",
    "logProgress": "bool",
    "logVerbose": "bool",
    "publishContentLink": {
      "contentHash": {
        "algorithm": "string",
        "value": "string"
      },
      "uri": "string",
      "version": "string"
    },
    "runbookType": "string",
    "runtimeEnvironment": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ContentHash

名字	描述	价值
算法	获取或设置用于对内容进行哈希处理的内容哈希算法。	string （必需）
价值	获取或设置内容的预期哈希值。	string （必需）

ContentLink

名字	描述	价值
contentHash	获取或设置哈希。	ContentHash
uri	获取或设置内容的 URI。	字符串
版本	获取或设置内容的版本。	字符串

Microsoft.Automation/automationAccounts/runbooks

名字	描述	价值
apiVersion	API 版本	'2024-10-23'
位置	获取或设置资源的位置。	字符串
名字	资源名称	字符串约束：模式 = `^[a-zA-Z][a-zA-Z-_0-9]*$` （必需）
性能	获取或设置 Runbook 创建或更新属性。	RunbookCreateOrUpdatePropertiesOrRunbookProperties（必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.Automation/automationAccounts/runbooks”

RunbookCreateOrUpdateParametersTags

名字	描述	价值

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名字	描述	价值
描述	获取或设置 Runbook 的说明。	字符串
草案	获取或设置草稿 Runbook 属性。	RunbookDraft
logActivityTrace	获取或设置 Runbook 的活动级跟踪选项。	int
logProgress	获取或设置进度日志选项。	bool
logVerbose	获取或设置详细日志选项。	bool
publishContentLink	获取或设置已发布的 Runbook 内容链接。	ContentLink
runbookType	获取或设置 Runbook 的类型。	“Graph” “GraphPowerShell” “GraphPowerShellWorkflow” “PowerShell” “PowerShell72” “PowerShellWorkflow” “Python” “Python2” “Python3” “Script”（必需）
runtimeEnvironment	Runbook 的环境。	字符串

RunbookDraft

名字	描述	价值
creationTime	获取或设置 Runbook 草稿的创建时间。	字符串
draftContentLink	获取或设置草稿 Runbook 内容链接。	ContentLink
inEdit	获取或设置 Runbook 是否处于编辑模式。	bool
lastModifiedTime	获取或设置 Runbook 草稿的上次修改时间。	字符串
outputTypes	获取或设置 Runbook 输出类型。	string[]
参数	获取或设置 Runbook 草稿参数。	RunbookDraftParameters

RunbookDraftParameters

名字	描述	价值

RunbookParameter

名字	描述	价值
defaultValue	获取或设置参数的默认值。	字符串
isMandatory	获取或设置一个布尔值，该值指示参数是否是必需的。	bool
位置	获取或设置参数的位置。	int
类型	获取或设置参数的类型。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
ASR Runbook	为 ASR 恢复计划部署自动化 Runbook
Azure 资源优化（ARO）工具包	Azure 资源优化工具包是一种分散的本机 Azure 解决方案，使用无服务器技术优化订阅上的 Azure 资源。启用或创建自己的计划（包括新资源）后，优化会自动在订阅上进行。这是一个 Azure 自动化帐户，其中包含预配置的 Runbook 和计划，可在订阅上利用这些帐户开始节省资金。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 automationAccounts/runbook 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Automation/automationAccounts/runbooks 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2024-10-23"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      description = "string"
      draft = {
        creationTime = "string"
        draftContentLink = {
          contentHash = {
            algorithm = "string"
            value = "string"
          }
          uri = "string"
          version = "string"
        }
        inEdit = bool
        lastModifiedTime = "string"
        outputTypes = [
          "string"
        ]
        parameters = {
          {customized property} = {
            defaultValue = "string"
            isMandatory = bool
            position = int
            type = "string"
          }
        }
      }
      logActivityTrace = int
      logProgress = bool
      logVerbose = bool
      publishContentLink = {
        contentHash = {
          algorithm = "string"
          value = "string"
        }
        uri = "string"
        version = "string"
      }
      runbookType = "string"
      runtimeEnvironment = "string"
    }
  })
}

属性值

ContentHash

名字	描述	价值
算法	获取或设置用于对内容进行哈希处理的内容哈希算法。	string （必需）
价值	获取或设置内容的预期哈希值。	string （必需）

ContentLink

名字	描述	价值
contentHash	获取或设置哈希。	ContentHash
uri	获取或设置内容的 URI。	字符串
版本	获取或设置内容的版本。	字符串

Microsoft.Automation/automationAccounts/runbooks

名字	描述	价值
位置	获取或设置资源的位置。	字符串
名字	资源名称	字符串约束：模式 = `^[a-zA-Z][a-zA-Z-_0-9]*$` （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：automationAccounts
性能	获取或设置 Runbook 创建或更新属性。	RunbookCreateOrUpdatePropertiesOrRunbookProperties（必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Automation/automationAccounts/runbooks@2024-10-23”

RunbookCreateOrUpdateParametersTags

名字	描述	价值

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名字	描述	价值
描述	获取或设置 Runbook 的说明。	字符串
草案	获取或设置草稿 Runbook 属性。	RunbookDraft
logActivityTrace	获取或设置 Runbook 的活动级跟踪选项。	int
logProgress	获取或设置进度日志选项。	bool
logVerbose	获取或设置详细日志选项。	bool
publishContentLink	获取或设置已发布的 Runbook 内容链接。	ContentLink
runbookType	获取或设置 Runbook 的类型。	“Graph” “GraphPowerShell” “GraphPowerShellWorkflow” “PowerShell” “PowerShell72” “PowerShellWorkflow” “Python” “Python2” “Python3” “Script”（必需）
runtimeEnvironment	Runbook 的环境。	字符串

RunbookDraft

名字	描述	价值
creationTime	获取或设置 Runbook 草稿的创建时间。	字符串
draftContentLink	获取或设置草稿 Runbook 内容链接。	ContentLink
inEdit	获取或设置 Runbook 是否处于编辑模式。	bool
lastModifiedTime	获取或设置 Runbook 草稿的上次修改时间。	字符串
outputTypes	获取或设置 Runbook 输出类型。	string[]
参数	获取或设置 Runbook 草稿参数。	RunbookDraftParameters

RunbookDraftParameters

名字	描述	价值

RunbookParameter

名字	描述	价值
defaultValue	获取或设置参数的默认值。	字符串
isMandatory	获取或设置一个布尔值，该值指示参数是否是必需的。	bool
位置	获取或设置参数的位置。	int
类型	获取或设置参数的类型。	字符串

通过

Microsoft.Automation automationAccounts/runbooks

Bicep 资源定义

资源格式

属性值

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

快速入门示例

ARM 模板资源定义

资源格式

属性值

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

ContentHash

ContentLink

Microsoft.Automation/automationAccounts/runbooks

RunbookCreateOrUpdateParametersTags

RunbookCreateOrUpdatePropertiesOrRunbookProperties

RunbookDraft

RunbookDraftParameters

RunbookParameter

反馈

其他资源