Microsoft.Automation automationAccounts/runbooks 2022-08-08

• 最新
• 2023-11-01
• 2023-05-15-preview
• 2022-08-08
• 2019-06-01
• 2018-06-30
• 2015-10-31

Bicep 資源定義

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

• 資源群組 - 請參閱 資源群組部署命令

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

資源格式

若要建立 Microsoft.Automation/automationAccounts/Runbooks 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2022-08-08' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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'
  }
}

屬性值

automationAccounts/runbooks

名稱	描述	值
NAME	資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。	需要字串 () 字元限制：1-63 合法字元： 英數字元、底線和連字號。 以字母開頭。
location	取得或設定資源的位置。	字串
tags	取得或設定附加在資源的標記。	標記名稱和值的字典。 請參閱 範本中的標籤
父系 (parent)	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型資源的符號名稱： automationAccounts
properties	取得或設定 Runbook 建立或更新屬性。	RunbookCreateOrUpdatePropertiesOrRunbookProperties (必要)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名稱	描述	值
description	取得或設定 Runbook 的描述。	字串
草案	取得或設定草稿 Runbook 屬性。	RunbookDraft
logActivityTrace	取得或設定 Runbook 的活動層級追蹤選項。	int
logProgress	取得或設定進度記錄選項。	bool
logVerbose	取得或設定詳細信息記錄選項。	bool
publishContentLink	取得或設定已發佈的 Runbook 內容連結。	ContentLink
runbookType	取得或設定 Runbook 的類型。	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShellWorkflow' 'Python2' 'Python3' 需要 『Script』 ()

RunbookDraft

名稱	描述	值
creationTime	取得或設定 Runbook 草稿的建立時間。	字串
draftContentLink	取得或設定草稿 Runbook 內容連結。	ContentLink
inEdit	取得或設定 Runbook 是否處於編輯模式。	bool
lastModifiedTime	取得或設定 Runbook 草稿的上次修改時間。	字串
outputTypes	取得或設定 Runbook 輸出類型。	string[]
參數	取得或設定 Runbook 草稿參數。	RunbookDraftParameters

ContentLink

名稱	描述	值
contentHash	取得或設定哈希。	ContentHash
uri	取得或設定 Runbook 內容的 URI。	字串
version	取得或設定內容的版本。	字串

ContentHash

名稱	描述	值
演算法	取得或設定用來哈希內容的內容哈希演算法。	需要字串 ()
值	取得或設定內容的預期哈希值。	需要字串 ()

RunbookDraftParameters

名稱	描述	值
{自定義屬性}		RunbookParameter

RunbookParameter

名稱	描述	值
defaultValue	取得或設定參數的預設值。	字串
isMandatory	取得或設定布爾值，指出參數是否為必要。	bool
position	取得或設定 參數的位置。	int
類型	取得或設定參數的類型。	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
ASR Runbook	部署 ASR 復原方案的自動化 Runbook
OMS ASR 解決方案	在 OMS 中啟用 ASR (v2) 解決方案
ARO) Toolkit (Azure 資源優化	Azure 資源優化工具組是一種分散式原生 Azure 解決方案，使用無伺服器技術將訂用帳戶上的 Azure 資源優化。 啟用或建立自己的排程之後，優化會自動在您的訂用帳戶上執行，包括新的資源。 這是 Azure 自動化 帳戶，其中包含預先設定的 Runbook 和排程，可讓您在訂用帳戶上利用以節省成本。
OMS - Azure 資源使用量解決方案	解決方案會將 Azure 資源的相關計費納入 OMS。 資源的成本可以以不同的貨幣和地區設定顯示。
OMS - Azure VM 清查解決方案	在 OMS 中啟用 Azure VM 清查解決方案。 解決方案會將 Azure VM 清查以及磁碟、網路元件、NSG 規則和擴充功能收集到 OMS 工作區。
OMS 解決方案 - Hyper-V 複本	建立 OMS 解決方案以監視 Hyper-V 複本的範本的範本。
OMS 服務總線解決方案	監視 Azure 服務匯流排 實例
OMS VMM 分析	提供跨多個 VMM 實例之作業狀態的單一檢視，協助您深入瞭解這些作業的健康情況 & 效能。
建立 Azure 自動化帳戶	此範本提供如何建立 Azure 自動化 帳戶，並將其連結至新的或現有的 Azure 監視器 Log Analytics 工作區的範例。

ARM 範本資源定義

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

• 資源群組 - 請參閱 資源群組部署命令

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

資源格式

若要建立 Microsoft.Automation/automationAccounts/Runbooks 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2022-08-08",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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"
  }
}

屬性值

automationAccounts/runbooks

名稱	描述	值
類型	資源類型	'Microsoft.Automation/automationAccounts/runbooks'
apiVersion	資源 API 版本	'2022-08-08'
NAME	資源名稱 瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。	需要字串 () 字元限制：1-63 合法字元： 英數字元、底線和連字號。 以字母開頭。
location	取得或設定資源的位置。	字串
tags	取得或設定附加在資源的標記。	標記名稱和值的字典。 請參閱 範本中的標記
properties	取得或設定 Runbook 建立或更新屬性。	RunbookCreateOrUpdatePropertiesOrRunbookProperties (必要)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名稱	描述	值
description	取得或設定 Runbook 的描述。	字串
草案	取得或設定草稿 Runbook 屬性。	RunbookDraft
logActivityTrace	取得或設定 Runbook 的活動層級追蹤選項。	int
logProgress	取得或設定進度記錄選項。	bool
logVerbose	取得或設定詳細信息記錄選項。	bool
publishContentLink	取得或設定已發佈的 Runbook 內容連結。	ContentLink
runbookType	取得或設定 Runbook 的類型。	'Graph' 'GraphPowerShell' 'GraphPowerShellWorkflow' 'PowerShell' 'PowerShellWorkflow' 'Python2' 'Python3' 需要 『Script』 ()

RunbookDraft

名稱	描述	值
creationTime	取得或設定 Runbook 草稿的建立時間。	字串
draftContentLink	取得或設定草稿 Runbook 內容連結。	ContentLink
inEdit	取得或設定 Runbook 是否處於編輯模式。	bool
lastModifiedTime	取得或設定 Runbook 草稿的上次修改時間。	字串
outputTypes	取得或設定 Runbook 輸出類型。	string[]
參數	取得或設定 Runbook 草稿參數。	RunbookDraftParameters

ContentLink

名稱	描述	值
contentHash	取得或設定哈希。	ContentHash
uri	取得或設定 Runbook 內容的 URI。	字串
version	取得或設定內容的版本。	字串

ContentHash

名稱	描述	值
演算法	取得或設定用來哈希內容的內容哈希演算法。	字串 (必要)
值	取得或設定內容的預期哈希值。	字串 (必要)

RunbookDraftParameters

名稱	描述	值
{自定義屬性}		RunbookParameter

RunbookParameter

名稱	描述	值
defaultValue	取得或設定參數的預設值。	字串
isMandatory	取得或設定布爾值，指出參數是否為必要。	bool
position	取得或設定 參數的位置。	int
類型	取得或設定參數的類型。	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
ASR Runbook	部署 ASR 復原方案的自動化 Runbook
OMS ASR 解決方案	在 OMS 中啟用 ASR (v2) 解決方案
Azure 資源優化 (ARO) 工具組	Azure 資源優化工具組是使用無伺服器技術的分散式原生 Azure 解決方案，可優化訂用帳戶上的 Azure 資源。 一旦您啟用或建立自己的排程，包括在新資源上，優化會自動在訂用帳戶上發生。 這是 Azure 自動化 帳戶，其中包含預先設定的 Runbook 和排程，您可以在訂用帳戶上利用以開始節省成本。
OMS - Azure 資源使用量解決方案	解決方案會將 Azure 資源的相關計費納入 OMS。 資源的成本可以以不同的貨幣和地區設定顯示。
OMS - Azure VM 清查解決方案	在 OMS 中啟用 Azure VM 清查解決方案。 解決方案會將 Azure VM 清查以及磁碟、網路元件、NSG 規則和擴充功能收集到 OMS 工作區。
OMS 解決方案 - Hyper-V 複本	用來建立 OMS 解決方案以監視 Hyper-V 複本的範本的範本。
OMS 服務總線解決方案	監視 Azure 服務匯流排 實例
OMS VMM 分析	提供跨多個 VMM 實例之作業狀態的單一檢視，協助您深入瞭解這些作業的健康情況 & 效能。
建立 Azure 自動化帳戶	此範本提供如何建立 Azure 自動化 帳戶，並將其連結至新的或現有的 Azure 監視器 Log Analytics 工作區的範例。

Terraform (AzAPI 提供者) 資源定義

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

• 資源群組

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

資源格式

若要建立 Microsoft.Automation/automationAccounts/Runbooks 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2022-08-08"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
    }
  })
}

屬性值

automationAccounts/runbooks

名稱	描述	值
類型	資源類型	“Microsoft.Automation/automationAccounts/runbooks@2022-08-08”
NAME	資源名稱	字串 (必要) 字元限制：1-63 合法字元： 英數字元、底線和連字號。 以字母開頭。
location	取得或設定資源的位置。	字串
parent_id	此資源之父系的資源標識碼。	類型資源的標識碼： automationAccounts
tags	取得或設定附加在資源的標記。	標記名稱和值的字典。
properties	取得或設定 Runbook 建立或更新屬性。	RunbookCreateOrUpdatePropertiesOrRunbookProperties (必要)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名稱	描述	值
description	取得或設定 Runbook 的描述。	字串
草案	取得或設定草稿 Runbook 屬性。	RunbookDraft
logActivityTrace	取得或設定 Runbook 的活動層級追蹤選項。	int
logProgress	取得或設定進度記錄選項。	bool
logVerbose	取得或設定詳細信息記錄選項。	bool
publishContentLink	取得或設定已發佈的 Runbook 內容連結。	ContentLink
runbookType	取得或設定 Runbook 的類型。	“Graph” “GraphPowerShell” “GraphPowerShellWorkflow” “PowerShell” “PowerShellWorkflow” “Python2” “Python3” 必要) 的「腳本」 (

RunbookDraft

名稱	描述	值
creationTime	取得或設定 Runbook 草稿的建立時間。	字串
draftContentLink	取得或設定草稿 Runbook 內容連結。	ContentLink
inEdit	取得或設定 Runbook 是否處於編輯模式。	bool
lastModifiedTime	取得或設定 Runbook 草稿的上次修改時間。	字串
outputTypes	取得或設定 Runbook 輸出類型。	string[]
參數	取得或設定 Runbook 草稿參數。	RunbookDraftParameters

ContentLink

名稱	描述	值
contentHash	取得或設定哈希。	ContentHash
uri	取得或設定 Runbook 內容的 URI。	字串
version	取得或設定內容的版本。	字串

ContentHash

名稱	描述	值
演算法	取得或設定用來哈希內容的內容哈希演算法。	字串 (必要)
值	取得或設定內容的預期哈希值。	字串 (必要)

RunbookDraftParameters

名稱	描述	值
{自定義屬性}		RunbookParameter

RunbookParameter

名稱	描述	值
defaultValue	取得或設定參數的預設值。	字串
isMandatory	取得或設定布爾值，指出參數是否為必要。	bool
position	取得或設定 參數的位置。	int
類型	取得或設定參數的類型。	字串