Microsoft.Automation automationAccounts/Runbooks

Bicep リソース定義

automationAccounts/Runbooks リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Automation/automationAccounts/Runbooks リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2023-11-01' = {
  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 で子リソースの名前と型を設定する方法を参照してください。
string (必須)

文字数制限: 1 から 63

有効な文字:
英数字、アンダースコア、およびハイフン。

文字で開始します。
location リソースの場所を取得または設定します。 string
tags リソースに接続されているタグを取得または設定します。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。
種類のリソースのシンボル名: automationAccounts
properties Runbook の作成プロパティまたは更新プロパティを取得または設定します。 RunbookCreateOrUpdatePropertiesOrRunbookProperties (必須)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名前 説明
description Runbook の説明を取得または設定します。 string
ドラフト 下書きの Runbook プロパティを取得または設定します。 RunbookDraft
logActivityTrace Runbook のアクティビティ レベルのトレース オプションを取得または設定します。 INT
logProgress 進行状況ログ オプションを取得または設定します。 [bool]
logVerbose 詳細ログ オプションを取得または設定します。 [bool]
publishContentLink 発行された Runbook コンテンツ リンクを取得または設定します。 ContentLink
runbookType Runbook の種類を取得または設定します。 'Graph'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python2'
'Python3'
'Script' (必須)

RunbookDraft

名前 説明
creationTime Runbook ドラフトの作成時間を取得または設定します。 string
draftContentLink 下書き Runbook コンテンツ リンクを取得または設定します。 ContentLink
inEdit Runbook が編集モードであるかどうかを取得または設定します。 [bool]
lastModifiedTime Runbook ドラフトの最終変更時刻を取得または設定します。 string
outputTypes Runbook の出力の種類を取得または設定します。 string[]
parameters Runbook の下書きパラメーターを取得または設定します。 RunbookDraftParameters
名前 説明
contentHash ハッシュを設定します。 ContentHash
uri コンテンツの URI を設定します。 string
version コンテンツのバージョンを設定します。 string

ContentHash

名前 説明
アルゴリズム コンテンツのハッシュに使用するコンテンツ ハッシュ アルゴリズムを取得または設定します。 string (必須)
value コンテンツの予想されるハッシュ値を取得または設定します。 string (必須)

RunbookDraftParameters

名前 説明
{カスタマイズされたプロパティ} RunbookParameter

RunbookParameter

名前 説明
defaultValue パラメーターの既定値を取得または設定します。 string
isMandatory パラメーターが必須かどうかを示すブール値を取得または設定します。 [bool]
position パラメーターの位置を取得または設定します。 INT
パラメーターの型を取得または設定します。 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
ASR Runbook

Azure にデプロイする
ASR 回復計画用の Automation Runbook をデプロイする
OMS ASR ソリューション

Azure にデプロイする
OMS で ASR (v2) ソリューションを有効にします
Azure Resource Optimization (ARO) Toolkit

Azure にデプロイする
Azure Resource Optimization Toolkit は、サーバーレス テクノロジを使用してサブスクリプション上の Azure リソースを最適化する、分散型のネイティブ Azure ソリューションです。 最適化は、新しいリソースを含め、独自のスケジュールを有効または作成すると、サブスクリプションで自動的に行われます。 これは、サブスクリプションで利用できる事前構成済みの Runbook とスケジュールを含むAzure Automation アカウントで、コストの節約を開始できます。
OMS - Azure Resource Usage Solution

Azure にデプロイする
ソリューションにより、Azure リソースに関する課金が OMS に導入されます。 リソースのコストは、異なる通貨とロケールで表示できます。
OMS - Azure VM インベントリ ソリューション

Azure にデプロイする
OMS で Azure VM インベントリ ソリューションを有効にします。 ソリューションは、ディスク、ネットワーク コンポーネント、NSG ルール、拡張機能と共に Azure VM インベントリを OMS ワークスペースに収集します。
OMS ソリューション - Hyper-V レプリカ

Azure にデプロイする
Hyper-V レプリカを監視する OMS ソリューションを作成するためのテンプレート。
OMS Service Bus ソリューション

Azure にデプロイする
Azure Service Bus インスタンスを監視します
OMS VMM Analytics

Azure にデプロイする
複数の VMM インスタンスにわたるジョブの状態を 1 つのビューで表示し、これらのジョブの正常性 & パフォーマンスに関する分析情報を得ることができます。
Azure Automation アカウントを作成する

Azure にデプロイする
このテンプレートでは、Azure Automation アカウントを作成し、新規または既存の Azure Monitor Log Analytics ワークスペースにリンクする方法の例を示します。

ARM テンプレート リソース定義

automationAccounts/Runbooks リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Automation/automationAccounts/Runbooks リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2023-11-01",
  "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

名前 説明
type リソースの種類 'Microsoft.Automation/automationAccounts/Runbooks'
apiVersion リソース API のバージョン '2023-11-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)

文字制限: 1 から 63

有効な文字:
英数字、アンダースコア、およびハイフン。

文字で開始します。
location リソースの場所を取得または設定します。 string
tags リソースに接続されているタグを取得または設定します。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties Runbook の作成または更新のプロパティを取得または設定します。 RunbookCreateOrUpdatePropertiesOrRunbookProperties (必須)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名前 説明
description Runbook の説明を取得または設定します。 string
ドラフト 下書き Runbook プロパティを取得または設定します。 RunbookDraft
logActivityTrace Runbook のアクティビティ レベルのトレース オプションを取得または設定します。 INT
logProgress 進行状況ログ オプションを取得または設定します。 [bool]
logVerbose 詳細ログ オプションを取得または設定します。 [bool]
publishContentLink 発行された Runbook コンテンツ リンクを取得または設定します。 ContentLink
runbookType Runbook の種類を取得または設定します。 'Graph'
'GraphPowerShell'
'GraphPowerShellWorkflow'
'PowerShell'
'PowerShell72'
'PowerShellWorkflow'
'Python2'
'Python3'
'Script' (必須)

RunbookDraft

名前 説明
creationTime Runbook ドラフトの作成時間を取得または設定します。 string
draftContentLink 下書き Runbook コンテンツ リンクを取得または設定します。 ContentLink
inEdit Runbook が編集モードかどうかを取得または設定します。 [bool]
lastModifiedTime Runbook ドラフトの最終変更時刻を取得または設定します。 string
outputTypes Runbook 出力の種類を取得または設定します。 string[]
parameters Runbook の下書きパラメーターを取得または設定します。 RunbookDraftParameters
名前 説明
contentHash ハッシュを設定します。 ContentHash
uri コンテンツの URI を設定します。 string
version コンテンツのバージョンを設定します。 string

ContentHash

名前 説明
アルゴリズム コンテンツのハッシュに使用するコンテンツ ハッシュ アルゴリズムを取得または設定します。 string (必須)
value コンテンツの予想されるハッシュ値を取得または設定します。 string (必須)

RunbookDraftParameters

名前 説明
{カスタマイズされたプロパティ} RunbookParameter

RunbookParameter

名前 説明
defaultValue パラメーターの既定値を取得または設定します。 string
isMandatory パラメーターが必須かどうかを示すブール値を取得または設定します。 [bool]
position パラメーターの位置を取得または設定します。 INT
パラメーターの型を取得または設定します。 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
ASR Runbook

Azure にデプロイする
ASR 回復計画用の Automation Runbook をデプロイする
OMS ASR ソリューション

Azure にデプロイする
OMS で ASR (v2) ソリューションを有効にします
Azure Resource Optimization (ARO) Toolkit

Azure にデプロイする
Azure Resource Optimization Toolkit は、サーバーレス テクノロジを使用してサブスクリプション上の Azure リソースを最適化する、分散型のネイティブ Azure ソリューションです。 最適化は、新しいリソースを含め、独自のスケジュールを有効または作成すると、サブスクリプションで自動的に行われます。 これは、サブスクリプションで利用できる事前構成済みの Runbook とスケジュールを含むAzure Automation アカウントで、コストの節約を開始できます。
OMS - Azure Resource Usage Solution

Azure にデプロイする
ソリューションにより、Azure リソースに関する課金が OMS に導入されます。 リソースのコストは、異なる通貨とロケールで表示できます。
OMS - Azure VM インベントリ ソリューション

Azure にデプロイする
OMS で Azure VM インベントリ ソリューションを有効にします。 ソリューションは、ディスク、ネットワーク コンポーネント、NSG ルール、拡張機能と共に Azure VM インベントリを OMS ワークスペースに収集します。
OMS ソリューション - Hyper-V レプリカ

Azure にデプロイする
Hyper-V レプリカを監視する OMS ソリューションを作成するためのテンプレート。
OMS Service Bus ソリューション

Azure にデプロイする
Azure Service Bus インスタンスを監視します
OMS VMM Analytics

Azure にデプロイする
複数の VMM インスタンスにわたるジョブの状態を 1 つのビューで表示し、これらのジョブの正常性 & パフォーマンスに関する分析情報を得ることができます。
Azure Automation アカウントを作成する

Azure にデプロイする
このテンプレートでは、Azure Automation アカウントを作成し、新規または既存の Azure Monitor Log Analytics ワークスペースにリンクする方法の例を示します。

Terraform (AzAPI プロバイダー) リソース定義

automationAccounts/Runbooks リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Automation/automationAccounts/Runbooks リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2023-11-01"
  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

名前 説明
type リソースの種類 "Microsoft.Automation/automationAccounts/runbooks@2023-11-01"
name リソース名 string (必須)

文字制限: 1 から 63

有効な文字:
英数字、アンダースコア、およびハイフン。

文字で開始します。
location リソースの場所を取得または設定します。 string
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: automationAccounts
tags リソースに接続されているタグを取得または設定します。 タグの名前と値のディクショナリ。
properties Runbook の作成または更新のプロパティを取得または設定します。 RunbookCreateOrUpdatePropertiesOrRunbookProperties (必須)

RunbookCreateOrUpdatePropertiesOrRunbookProperties

名前 説明
description Runbook の説明を取得または設定します。 string
ドラフト 下書き Runbook プロパティを取得または設定します。 RunbookDraft
logActivityTrace Runbook のアクティビティ レベルのトレース オプションを取得または設定します。 INT
logProgress 進行状況ログ オプションを取得または設定します。 [bool]
logVerbose 詳細ログ オプションを取得または設定します。 [bool]
publishContentLink 発行された Runbook コンテンツ リンクを取得または設定します。 ContentLink
runbookType Runbook の種類を取得または設定します。 "Graph"
"GraphPowerShell"
"GraphPowerShellWorkflow"
"PowerShell"
"PowerShell72"
"PowerShellWorkflow"
"Python2"
"Python3"
"Script" (必須)

RunbookDraft

名前 説明
creationTime Runbook ドラフトの作成時間を取得または設定します。 string
draftContentLink 下書き Runbook コンテンツ リンクを取得または設定します。 ContentLink
inEdit Runbook が編集モードであるかどうかを取得または設定します。 [bool]
lastModifiedTime Runbook ドラフトの最終変更時刻を取得または設定します。 string
outputTypes Runbook の出力の種類を取得または設定します。 string[]
parameters Runbook の下書きパラメーターを取得または設定します。 RunbookDraftParameters
名前 説明
contentHash ハッシュを設定します。 ContentHash
uri コンテンツの URI を設定します。 string
version コンテンツのバージョンを設定します。 string

ContentHash

名前 説明
アルゴリズム コンテンツのハッシュに使用するコンテンツ ハッシュ アルゴリズムを取得または設定します。 string (必須)
value コンテンツの予想されるハッシュ値を取得または設定します。 string (必須)

RunbookDraftParameters

名前 説明
{カスタマイズされたプロパティ} RunbookParameter

RunbookParameter

名前 説明
defaultValue パラメーターの既定値を取得または設定します。 string
isMandatory パラメーターが必須かどうかを示すブール値を取得または設定します。 [bool]
position パラメーターの位置を取得または設定します。 INT
パラメーターの型を取得または設定します。 string