共用方式為

Microsoft.Automation automationAccounts/Runbooks

  • 發行項

Bicep 資源定義

automationAccounts/Runbook 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Automation/automationAccounts/Runbooks 資源，請將下列 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

名字 描述 價值
演算法 取得或設定用來哈希內容的內容哈希演算法。 字串 （必要）
價值 取得或設定內容的預期哈希值。 字串 （必要）
名字 描述 價值
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

名字 描述 價值
演算法 取得或設定用來哈希內容的內容哈希演算法。 字串 （必要）
價值 取得或設定內容的預期哈希值。 字串 （必要）
名字 描述 價值
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

部署至 Azure 		部署適用於 ASR 復原方案的自動化 Runbook
Azure 資源優化 （ARO） 工具組

部署至 Azure 		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

名字 描述 價值
演算法 取得或設定用來哈希內容的內容哈希演算法。 字串 （必要）
價值 取得或設定內容的預期哈希值。 字串 （必要）
名字 描述 價值
contentHash 取得或設定哈希。 ContentHash
uri 取得或設定內容的 URI。 字串
版本 取得或設定內容的版本。 字串

Microsoft.Automation/automationAccounts/runbooks

名字 描述 價值
位置 取得或設定資源的位置。 字串
名字 資源名稱 字串

約束：
模式 = ^[a-zA-Z][a-zA-Z-_0-9]*$ （必要）
parent_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
類型 取得或設定 參數的類型。 字串