Microsoft.Automation automationAccounts/Runbooks

• 最新の を する
• 2024-10-23
• 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@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 復旧計画用の Automation Runbook をデプロイする

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

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

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 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 の Azure にデプロイする	ASR 復旧計画用の Automation Runbook をデプロイする
Azure Resource Optimization (ARO) Toolkit Azure にデプロイする	Azure Resource Optimization Toolkit は、サーバーレス テクノロジを使用してサブスクリプション上の Azure リソースを最適化する分散型のネイティブ Azure ソリューションです。 新しいリソースを含め、独自のスケジュールを有効または作成すると、サブスクリプションで最適化が自動的に行われます。 これは、サブスクリプションで使用してコストの節約を開始できる、構成済みの Runbook とスケジュールを含む Azure Automation アカウントです。

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

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

• リソース グループの

各 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
種類	パラメーターの型を取得または設定します。	糸