次の方法で共有


az automation runbook

Note

This reference is part of the automation extension for the Azure CLI (version 2.55.0 or higher). 拡張機能は、az automation Runbook コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

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

Automation Runbook.

コマンド

名前 説明 状態
az automation runbook create

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

Extension Experimental
az automation runbook delete

名前で Runbook を削除します。

Extension Experimental
az automation runbook list

Runbook の一覧を取得します。

Extension Experimental
az automation runbook publish

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

Extension Experimental
az automation runbook replace-content

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

Extension Experimental
az automation runbook revert-to-published

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

Extension Experimental
az automation runbook show

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

Extension Experimental
az automation runbook start

Runbook を開始します。

Extension Experimental
az automation runbook update

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

Extension Experimental
az automation runbook wait

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

Extension Experimental

az automation runbook create

実験用

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

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

az automation runbook create --automation-account-name
                             --name --runbook-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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az automation runbook delete

実験用

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

名前で Runbook を削除します。

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

Runbook を削除する

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name --runbook-name -n

Runbook 名。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--yes -y

確認を求めないでください。

プロパティ
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az automation runbook publish

実験用

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

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

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

Runbook の下書きを発行する

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name --runbook-name -n

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

プロパティ
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az automation runbook replace-content

実験用

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

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

az automation runbook replace-content --content
                                      [--automation-account-name]
                                      [--ids]
                                      [--name --runbook-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 のコンテンツ。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name --runbook-name -n

Runbook 名。

プロパティ
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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 --runbook-name]
                                          [--resource-group]
                                          [--subscription]

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

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name --runbook-name -n

Runbook 名。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az automation runbook show

実験用

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

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

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

Get runbook

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name --runbook-name -n

Runbook 名。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az automation runbook start

実験用

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

Runbook を開始します。

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

Runbook の起動

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name --runbook-name -n

Runbook 名。

プロパティ
Parameter group: Resource Id Arguments
--parameters

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

--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--run-on

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

--subscription

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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 --runbook-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"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--description

Runbook の説明。

--ids

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

プロパティ
Parameter group: Resource Id Arguments
--log-activity-trace

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

--log-progress

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

プロパティ
指定可能な値: false, true
--log-verbose

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

プロパティ
指定可能な値: false, true
--name --runbook-name -n

Runbook 名。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--tags

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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 --runbook-name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

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

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--automation-account-name

Automation アカウントの名前。

プロパティ
Parameter group: Resource Id Arguments
--created

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--custom

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

プロパティ
Parameter group: Wait Condition Arguments
--deleted

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--exists

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--interval

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 30
--name --runbook-name -n

Runbook 名。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--timeout

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False