az fleet updaterun

リファレンス

Note

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

更新プログラムの実行を管理するコマンド。

コマンド

名前	説明	型	状態
az fleet updaterun create	更新プログラムの実行を作成または更新します。	拡張子	GA
az fleet updaterun delete	更新プログラムの実行を削除します。	拡張子	GA
az fleet updaterun list	フリートの更新実行を一覧表示します。	拡張子	GA
az fleet updaterun show	更新プログラムの実行を表示します。	拡張子	GA
az fleet updaterun skip	UpdateRun 内でスキップされるターゲットを設定します。	拡張子	GA
az fleet updaterun start	更新プログラムの実行を開始します。	拡張子	GA
az fleet updaterun stop	更新プログラムの実行を停止します。	拡張子	GA
az fleet updaterun wait	更新プログラムの実行リソースが目的の状態になるまで待ちます。	拡張子	GA

az fleet updaterun create

更新プログラムの実行を作成または更新します。

az fleet updaterun create --fleet-name
                          --name
                          --resource-group
                          --upgrade-type {ControlPlaneOnly, Full, NodeImageOnly}
                          [--kubernetes-version]
                          [--no-wait]
                          [--node-image-selection {Consistent, Latest}]
                          [--stages]
                          [--update-strategy-name]

例

'Full' アップグレードタイプのフリートの更新実行を作成します。

az fleet updaterun create -g MyResourceGroup -f MyFleet -n MyUpdateRun --upgrade-type Full --kubernetes-version 1.25.0 --node-image-selection Latest

'NodeImageOnly' アップグレードの種類を持つフリートの更新実行を作成します。

az fleet updaterun create -g MyResourceGroup -f MyFleet -n MyUpdateRun --upgrade-type NodeImageOnly --node-image-selection Latest

'Full' アップグレードの種類とステージを持つフリートの更新プログラムの実行を作成します。

az fleet updaterun create -g MyResourceGroup -f MyFleet -n MyUpdateRun --upgrade-type Full --kubernetes-version 1.25.0 --node-image-selection Latest --stages ./test/stages.json

    The following JSON structure represents example contents of the parameter '--stages ./test/stages.json'.
    A stages array is composed of one or more stages, each containing one or more groups.
    Each group contains the 'name' property, which represents the group to which a cluster belongs (see 'az fleet member create --help').
    Stages have an optional 'afterStageWaitInSeconds' integer property, acting as a delay between stage execution.
    {
        "stages": [
            {
                "name": "stage1",
                "groups": [
                    {
                        "name": "group-a1"
                    },
                    {
                        "name": "group-a2"
                    },
                    {
                        "name": "group-a3"
                    }
                ],
                "afterStageWaitInSeconds": 3600
            },
            {
                "name": "stage2",
                "groups": [
                    {
                        "name": "group-b1"
                    },
                    {
                        "name": "group-b2"
                    },
                    {
                        "name": "group-b3"
                    }
                ]
            },
        ]
    }

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--name -n

更新プログラムの実行の名前を指定します。

--resource-group -g

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

--upgrade-type

メンバーのアップグレードの種類を指定します。使用できる値は、'Full'、'ControlPlaneOnly'、および 'NodeImageOnly' です。

指定可能な値: ControlPlaneOnly, Full, NodeImageOnly

省略可能のパラメーター

--kubernetes-version

--upgrade-type が 'Full' または 'ControlPlaneOnly' に設定されている場合に、メンバーをアップグレードする kubernetes バージョンを指定します。許容される形式は x.x.x (例: 1.2.3) です。

--no-wait

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

規定値: False

--node-image-selection

ノードイメージの選択は、クラスターのノードのアップグレード方法を選択できるオプションです。

指定可能な値: Consistent, Latest

--stages

フリートをアップグレードするステージを定義する JSON ファイルへのパス。リファレンスについては、例を参照してください。

--update-strategy-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 fleet updaterun delete

更新プログラムの実行を削除します。

az fleet updaterun delete --fleet-name
                          --name
                          --resource-group
                          [--no-wait]
                          [--yes]

例

更新プログラムの実行を削除します。

az fleet updaterun delete -g MyFleetResourceGroup -f MyFleetName -n NameofUpdateRun

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--name -n

更新プログラムの実行の名前を指定します。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

規定値: False

--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 fleet updaterun list

フリートの更新実行を一覧表示します。

az fleet updaterun list --fleet-name
                        --resource-group

例

更新プログラムの実行の詳細を表示します。

az fleet updaterun list -g MyFleetResourceGroup -f MyFleetName

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--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 fleet updaterun show

更新プログラムの実行を表示します。

az fleet updaterun show --fleet-name
                        --name
                        --resource-group

例

更新プログラムの実行の詳細を表示します。

az fleet updaterun show -g MyFleetResourceGroup -f MyFleetName -n NameofUpdateRun

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--name -n

更新プログラムの実行の名前を指定します。

--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 fleet updaterun skip

UpdateRun 内でスキップされるターゲットを設定します。

az fleet updaterun skip --fleet-name
                        --name
                        --resource-group
                        [--no-wait]
                        [--targets]

例

スキップする 2 つのターゲットを設定します。

az fleet updaterun skip -g MyFleetResourceGroup -f MyFleetName -n NameofUpdateRun --targets Group:my-group-name Stage:my-stage-name

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--name -n

更新プログラムの実行の名前を指定します。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

規定値: False

--targets

プレビュー

スキップするターゲットのスペース区切りのリスト。ターゲットは、Group:MyGroup などの 'targetType:targetName' の形式である必要があります。有効なターゲット型は ('Member'、'Group'、'Stage'、'AfterStageWait') です。ターゲットの種類では大文字と小文字が区別されます。

グローバルパラメーター

--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 fleet updaterun start

更新プログラムの実行を開始します。

az fleet updaterun start --fleet-name
                         --name
                         --resource-group
                         [--no-wait]

例

更新プログラムの実行を開始します。

az fleet updaterun start -g MyFleetResourceGroup -f MyFleetName -n NameofUpdateRun

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--name -n

更新プログラムの実行の名前を指定します。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

規定値: 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 fleet updaterun stop

更新プログラムの実行を停止します。

az fleet updaterun stop --fleet-name
                        --name
                        --resource-group
                        [--no-wait]

例

更新プログラムの実行を停止します。

az fleet updaterun stop -g MyFleetResourceGroup -f MyFleetName -n NameofUpdateRun

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--name -n

更新プログラムの実行の名前を指定します。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

規定値: 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 fleet updaterun wait

更新プログラムの実行リソースが目的の状態になるまで待ちます。

更新プログラムの実行に対する操作が中断されたか、 --no-waitで開始された場合は、このコマンドを使用して完了するまで待機します。

az fleet updaterun wait --fleet-name
                        --resource-group
                        --update-run-name
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

必須のパラメーター

--fleet-name -f

フリート名を指定します。

--resource-group -g

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

--update-run-name

UpdateRun リソースの名前。必須。

省略可能のパラメーター

--created

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

規定値: False

--custom

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

--deleted

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

規定値: False

--exists

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

規定値: False

--interval

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

規定値: 30

--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 を使います。

次の方法で共有

az fleet updaterun

コマンド

az fleet updaterun create

例

必須のパラメーター

省略可能のパラメーター

az fleet updaterun delete

例

必須のパラメーター

省略可能のパラメーター

az fleet updaterun list

例

必須のパラメーター

az fleet updaterun show

例

必須のパラメーター

az fleet updaterun skip

例

必須のパラメーター

省略可能のパラメーター

az fleet updaterun start

例

必須のパラメーター

省略可能のパラメーター

az fleet updaterun stop

例

必須のパラメーター

省略可能のパラメーター

az fleet updaterun wait

必須のパラメーター

省略可能のパラメーター

その他のリソース