az network lb probe

プローブ情報を評価し、ルーティング規則を定義します。

コマンド

名前	説明	型	状態
az network lb probe create	負荷分散でプローブを作成します。	Core	GA
az network lb probe delete	ロード バランサー内のプローブを削除します。	Core	GA
az network lb probe list	ロード バランサー内のプローブを一覧表示します。	Core	GA
az network lb probe show	ロード バランサー内のプローブの詳細を取得します。	Core	GA
az network lb probe update	ロード バランサーのプローブを更新します。	Core	GA
az network lb probe wait	条件が満たされるまで CLI を待機状態にします。	Core	GA

az network lb probe create

負荷分散でプローブを作成します。

az network lb probe create --lb-name
                           --name
                           --port
                           --protocol {Http, Https, Tcp}
                           --resource-group
                           [--interval --interval-in-seconds]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--number-of-probes --threshold]
                           [--path --request-path]
                           [--probe-threshold]

例

HTTP とポート 80 経由でロード バランサーにプローブを作成します。

az network lb probe create -g MyResourceGroup --lb-name MyLb -n MyProbe --protocol http --port 80 --path /

ポート 443 の TCP 経由でロード バランサーにプローブを作成します。

az network lb probe create -g MyResourceGroup --lb-name MyLb -n MyProbe --protocol tcp --port 443

必須のパラメーター

--lb-name

ロード バランサー名。

--name -n

プローブの名前。

--port

プローブを通信するためのポート。 指定できる値の範囲は 1 ~ 65535 です。

プロパティ	値
Parameter group:	Properties Arguments

--protocol

エンドポイントのプロトコル。

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	Http, Https, Tcp

--resource-group -g

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

省略可能のパラメーター

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

--interval --interval-in-seconds

エンドポイントの正常性状態をプローブする頻度を秒単位で指定します。

プロパティ	値
Parameter group:	Properties Arguments

--no-wait

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

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--number-of-probes --threshold

インスタンスが異常と見なされるまでのプローブの連続失敗の数。

プロパティ	値
Parameter group:	Properties Arguments

--path --request-path

VM から正常性状態を要求するために使用される URI。 プロトコルが http に設定されている場合は、パスが必要です。 それ以外の場合は許可されません。

プロパティ	値
Parameter group:	Properties Arguments

--probe-threshold

このエンドポイントへのトラフィックの配信を許可または拒否するための連続した成功または失敗したプローブの数。 現在プレビュー段階であり、運用環境のワークロードには推奨されません。 ほとんどのシナリオでは、プロパティの値を指定しないことで、既定値の 1 を維持することをお勧めします。

プロパティ	値
Parameter group:	Properties 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/ を参照してください。

--subscription

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

--verbose

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

プロパティ	値
規定値:	False

az network lb probe delete

ロード バランサー内のプローブを削除します。

az network lb probe delete --lb-name
                           --name
                           --resource-group
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

例

プローブを削除します。

az network lb probe delete -g MyResourceGroup --lb-name MyLb -n MyProbe

必須のパラメーター

--lb-name

ロード バランサー名。

--name -n

プローブの名前。

--resource-group -g

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

省略可能のパラメーター

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

--no-wait

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

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

グローバル パラメーター

--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 network lb probe list

ロード バランサー内のプローブを一覧表示します。

az network lb probe list --lb-name
                         --resource-group

例

List probes

az network lb probe list -g MyResourceGroup --lb-name MyLb

必須のパラメーター

--lb-name

ロード バランサー名。

--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 network lb probe show

ロード バランサー内のプローブの詳細を取得します。

az network lb probe show --lb-name
                         --name
                         --resource-group

例

プローブの詳細を取得します。

az network lb probe show -g MyResourceGroup --lb-name MyLb -n MyProbe

必須のパラメーター

--lb-name

ロード バランサー名。

--name -n

プローブの名前。

--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 network lb probe update

ロード バランサーのプローブを更新します。

az network lb probe update --lb-name
                           --name
                           --resource-group
                           [--add]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--interval --interval-in-seconds]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--number-of-probes --threshold]
                           [--path --request-path]
                           [--port]
                           [--probe-threshold]
                           [--protocol {Http, Https, Tcp}]
                           [--remove]
                           [--set]

例

別のポートと間隔でプローブを更新します。

az network lb probe update -g MyResourceGroup --lb-name MyLb -n MyProbe --port 81 --interval 10

必須のパラメーター

--lb-name

ロード バランサー名。

--name -n

プローブの名前。

--resource-group -g

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

省略可能のパラメーター

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

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
Parameter group:	Generic Update Arguments

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
Parameter group:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--interval --interval-in-seconds

エンドポイントの正常性状態をプローブする頻度を秒単位で指定します。

プロパティ	値
Parameter group:	Properties Arguments

--no-wait

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

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--number-of-probes --threshold

インスタンスが異常と見なされるまでのプローブの連続失敗の数。

プロパティ	値
Parameter group:	Properties Arguments

--path --request-path

VM から正常性状態を要求するために使用される URI。 プロトコルが http に設定されている場合は、パスが必要です。 それ以外の場合は許可されません。

プロパティ	値
Parameter group:	Properties Arguments

--port

プローブを通信するためのポート。 指定できる値の範囲は 1 ~ 65535 です。

プロパティ	値
Parameter group:	Properties Arguments

--probe-threshold

このエンドポイントへのトラフィックの配信を許可または拒否するための連続した成功または失敗したプローブの数。 現在プレビュー段階であり、運用環境のワークロードには推奨されません。 ほとんどのシナリオでは、プロパティの値を指定しないことで、既定値の 1 を維持することをお勧めします。

プロパティ	値
Parameter group:	Properties Arguments

--protocol

エンドポイントのプロトコル。

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	Http, Https, Tcp

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
Parameter group:	Generic Update Arguments

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ	値
Parameter group:	Generic Update 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/ を参照してください。

--subscription

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

--verbose

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

プロパティ	値
規定値:	False

az network lb probe wait

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

az network lb probe wait [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--lb-name]
                         [--resource-group]
                         [--subscription]
                         [--timeout]
                         [--updated]

省略可能のパラメーター

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

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

--lb-name

ロード バランサー名。

プロパティ	値
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