az automation runbook

Note

このリファレンスは、Azure CLI (バージョン 2.55.0 以降) のオートメーション拡張機能の一部です。 拡張機能は、az automation Runbook コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

このコマンド グループは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Automation Runbook。

コマンド

名前	説明	型	Status
az automation runbook create	Runbook 名で識別される Runbook を作成します。	拡張子	実験用
az automation runbook delete	名前で Runbook を削除します。	拡張子	実験用
az automation runbook list	Runbook の一覧を取得します。	拡張子	実験用
az automation runbook publish	Runbook の下書きを発行します。	拡張子	実験用
az automation runbook replace-content	Runbook のコンテンツを置き換えます。	拡張子	実験用
az automation runbook revert-to-published	Runbook コンテンツを最後の既知の発行済み状態に戻します。	拡張子	実験用
az automation runbook show	Runbook 名で識別される Runbook を取得します。	拡張子	実験用
az automation runbook start	Runbook を開始します。	拡張子	実験用
az automation runbook update	Runbook 名で識別される Runbook を更新します。	拡張子	実験用
az automation runbook wait	Automation Runbook の条件が満たされるまで、CLI を待機状態にします。	拡張子	実験用

az automation runbook create

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook 名で識別される Runbook を作成します。

az automation runbook create --automation-account-name
                             --name
                             --resource-group
                             --type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script}
                             [--description]
                             [--location]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--tags]

例

Runbook を作成する

az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --type "PowerShell" --location "East US 2"

必須のパラメーター

--automation-account-name

Automation アカウントの名前。

--name --runbook-name -n

Runbook 名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--type

Runbook の種類。

承認された値: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

省略可能のパラメーター

--description

Runbook の説明。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--log-activity-trace

Runbook のアクティビティ レベルのトレース オプション。

--log-progress

Runbook の進行状況ログ オプション。

承認された値: false, true

--log-verbose

Runbook の詳細ログ オプション。

承認された値: false, true

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook delete

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

名前で Runbook を削除します。

az automation runbook delete [--automation-account-name]
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--yes]

例

Runbook を削除する

az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --runbook-name -n

Runbook 名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook list

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook の一覧を取得します。

az automation runbook list --automation-account-name
                           --resource-group

例

Automation アカウント別に Runbook を一覧表示する

az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"

必須のパラメーター

--automation-account-name

Automation アカウントの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook publish

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook の下書きを発行します。

az automation runbook publish [--automation-account-name]
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]

例

Runbook の下書きを発行する

az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook"

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --runbook-name -n

Runbook の発行操作に指定されたパラメーター。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook replace-content

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook のコンテンツを置き換えます。

az automation runbook replace-content --content
                                      [--automation-account-name]
                                      [--ids]
                                      [--name]
                                      [--no-wait]
                                      [--resource-group]
                                      [--subscription]

例

Runbook のコンテンツを置き換える

az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook" --content @/path/to/script

必須のパラメーター

--content

Runbook のコンテンツ。

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --runbook-name -n

Runbook 名。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook revert-to-published

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook コンテンツを最後の既知の発行済み状態に戻します。

az automation runbook revert-to-published [--automation-account-name]
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

例

Runbook のコンテンツを置き換える

az automation runbook revert-to-published --automation-account-name "myAutomationAccount"                --resource-group "rg" --name "myRunbook"

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --runbook-name -n

Runbook 名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook show

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook 名で識別される Runbook を取得します。

az automation runbook show [--automation-account-name]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

例

Runbook を取得する

az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --runbook-name -n

Runbook 名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook start

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook を開始します。

az automation runbook start [--automation-account-name]
                            [--ids]
                            [--name]
                            [--parameters]
                            [--resource-group]
                            [--run-on]
                            [--subscription]

例

Runbook の起動

az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --runbook-name -n

Runbook 名。

--parameters

ジョブのパラメーター。 期待値: KEY1=VALUE1 KEY2=VALUE2 ...

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--run-on

ジョブを実行するグループ名を指定する RunOn。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook update

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook 名で識別される Runbook を更新します。

az automation runbook update [--automation-account-name]
                             [--description]
                             [--ids]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--tags]

例

Runbook を更新する

az automation runbook update --automation-account-name "myAutomationAccount" --description                "Runbook Description" --log-activity-trace 1 --log-progress true --log-verbose false                --resource-group "rg" --runbook-name "myRunbook"

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--description

Runbook の説明。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--log-activity-trace

Runbook のアクティビティ レベルのトレース オプション。

--log-progress

Runbook の進行状況ログ オプション。

承認された値: false, true

--log-verbose

Runbook の詳細ログ オプション。

承認された値: false, true

--name --runbook-name -n

Runbook 名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az automation runbook wait

実験用

コマンド グループ "Automation Runbook" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Automation Runbook の条件が満たされるまで、CLI を待機状態にします。

az automation runbook wait [--automation-account-name]
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

例

Automation Runbook が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --created

省略可能のパラメーター

--automation-account-name

Automation アカウントの名前。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

既定値: 30

--name --runbook-name -n

Runbook 名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

既定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。