az network lb rule

負荷分散規則を管理します。

コマンド

名前	説明	型	状態
az network lb rule create	負荷分散規則の作成	コア	GA
az network lb rule delete	負荷分散規則を削除します。	コア	GA
az network lb rule list	負荷分散規則を一覧表示します。	コア	GA
az network lb rule show	負荷分散規則の詳細を取得します。	コア	GA
az network lb rule update	負荷分散規則を更新します。	コア	GA
az network lb rule wait	条件が満たされるまで CLI を待機状態にします。	コア	GA

az network lb rule create

負荷分散規則の作成

az network lb rule create --backend-port
                          --frontend-port
                          --lb-name
                          --name
                          --protocol {All, Tcp, Udp}
                          --resource-group
                          [--backend-pool-name]
                          [--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                          [--frontend-ip]
                          [--idle-timeout]
                          [--load-distribution {Default, SourceIP, SourceIPProtocol}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--probe]

例

アドレス プールとポートに対して前面向けの IP 構成とポートを割り当てる負荷分散規則を作成します。

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip MyFrontEndIp --frontend-port 80 --backend-pool-name MyAddressPool --backend-port 80

フローティング IP 機能を使用して、アドレス プールとポートに前面向きの IP 構成とポートを割り当てる負荷分散規則を作成します。

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip MyFrontEndIp --backend-pool-name MyAddressPool --floating-ip true --frontend-port 80 --backend-port 80

同じポート上のプールで使用可能なすべてのバックエンド IP を使用するようにフロントエンド IP とポートを割り当てる HA ポート負荷分散規則を作成します。

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyHAPortsRule --protocol All --frontend-port 0 --backend-port 0 --frontend-ip MyFrontendIp --backend-pool-name MyAddressPool

必須のパラメーター

--backend-port

エンドポイントの内部接続に使用されるポート。 使用できる値は 0 ~ 65535 です。 値 0 では "任意のポート" が有効になります。

--frontend-port

外部エンドポイントのポートです。 各規則のポート番号は、ロード バランサー内で一意である必要があります。 使用できる値は 0 ~ 65534 です。 値 0 では "任意のポート" が有効になります。

--lb-name

ロード バランサー名。

--name -n

負荷分散規則の名前。

--protocol

負荷分散規則で使用されるトランスポート プロトコルへの参照。

指定可能な値: All, Tcp, Udp

--resource-group -g

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

省略可能のパラメーター

--backend-pool-name --backend-pools-name

バックエンド アドレス プールの ID または名前の一覧。 複数のプールは、ゲートウェイ SKU ロード バランサーでのみサポートされます。 1 つだけ存在する場合は、既定値として使用する場合は省略します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--disable-outbound-snat

負荷分散規則のフロントエンドで指定されたパブリック IP アドレスを使用するように、バックエンド プール内の VM の SNAT を構成します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--enable-floating-ip --floating-ip

SQL AlwaysOn 可用性グループを構成するために必要なフローティング IP 機能用に仮想マシンのエンドポイントを構成します。 この設定は、SQL Server で SQL AlwaysOn 可用性グループを使用する場合に必要です。 エンドポイントを作成した後は、この設定を変更できません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--enable-tcp-reset

TCP フローのアイドル タイムアウトまたは予期しない接続終了時に双方向 TCP リセットを受信します。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--frontend-ip --frontend-ip-name

フロントエンド IP 構成の ID の名前。

--idle-timeout --idle-timeout-in-minutes

TCP アイドル接続のタイムアウト。 値は 4 ~ 30 分の間で設定できます。 既定値は 4 分です。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。

--load-distribution

この規則の負荷分散ポリシー。

指定可能な値: Default, SourceIP, SourceIPProtocol

規定値: Default

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--probe --probe-name

この規則に関連付ける既存のプローブの 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 network lb rule delete

負荷分散規則を削除します。

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

例

負荷分散規則を削除します。

az network lb rule delete -g MyResourceGroup --lb-name MyLb -n MyLbRule

必須のパラメーター

--lb-name

ロード バランサー名。

--name -n

負荷分散規則の名前。

--resource-group -g

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

省略可能のパラメーター

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

グローバル パラメーター

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

負荷分散規則を一覧表示します。

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

例

負荷分散規則を一覧表示します。

az network lb rule list -g MyResourceGroup --lb-name MyLb -o table

必須のパラメーター

--lb-name

ロード バランサー名。

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

負荷分散規則の詳細を取得します。

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

例

負荷分散規則の詳細を取得します。

az network lb rule show -g MyResourceGroup --lb-name MyLb -n MyLbRule

必須のパラメーター

--lb-name

ロード バランサー名。

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

負荷分散規則を更新します。

az network lb rule update --lb-name
                          --name
                          --resource-group
                          [--add]
                          [--backend-pool-name]
                          [--backend-port]
                          [--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--frontend-ip]
                          [--frontend-port]
                          [--idle-timeout]
                          [--load-distribution {Default, SourceIP, SourceIPProtocol}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--probe]
                          [--protocol {All, Tcp, Udp}]
                          [--remove]
                          [--set]

例

負荷分散規則を更新して、プロトコルを UDP に変更します。

az network lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Udp

HA ポートをサポートするように負荷分散規則を更新します。

az network lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol All --frontend-port 0 --backend-port 0

必須のパラメーター

--lb-name

ロード バランサー名。

--name -n

負荷分散規則の名前。

--resource-group -g

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

省略可能のパラメーター

--add

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

--backend-pool-name --backend-pools-name

バックエンド アドレス プールの ID または名前の一覧。 複数のプールは、ゲートウェイ SKU ロード バランサーでのみサポートされます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--backend-port

エンドポイントの内部接続に使用されるポート。 使用できる値は 0 ~ 65535 です。 値 0 では "任意のポート" が有効になります。

--disable-outbound-snat

負荷分散規則のフロントエンドで指定されたパブリック IP アドレスを使用するように、バックエンド プール内の VM の SNAT を構成します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--enable-floating-ip --floating-ip

SQL AlwaysOn 可用性グループを構成するために必要なフローティング IP 機能用に仮想マシンのエンドポイントを構成します。 この設定は、SQL Server で SQL AlwaysOn 可用性グループを使用する場合に必要です。 エンドポイントを作成した後は、この設定を変更できません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--enable-tcp-reset

TCP フローのアイドル タイムアウトまたは予期しない接続終了時に双方向 TCP リセットを受信します。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--force-string

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--frontend-ip --frontend-ip-name

フロントエンド IP 構成の ID の名前。

--frontend-port

外部エンドポイントのポートです。 各規則のポート番号は、ロード バランサー内で一意である必要があります。 使用できる値は 0 ~ 65534 です。 値 0 では "任意のポート" が有効になります。

--idle-timeout --idle-timeout-in-minutes

TCP アイドル接続のタイムアウト。 値は 4 ~ 30 分の間で設定できます。 既定値は 4 分です。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。

--load-distribution

この規則の負荷分散ポリシー。

指定可能な値: Default, SourceIP, SourceIPProtocol

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--probe --probe-name

この規則に関連付ける既存のプローブの ID または名前。

--protocol

負荷分散規則で使用されるトランスポート プロトコルへの参照。

指定可能な値: All, Tcp, Udp

--remove

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

--set

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

グローバル パラメーター

--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 network lb rule wait

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

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

省略可能のパラメーター

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

--lb-name

ロード バランサー名。

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