az network lb rule
負荷分散規則を管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az network lb rule create |
負荷分散規則の作成 |
Core | GA |
| az network lb rule delete |
負荷分散規則を削除します。 |
Core | GA |
| az network lb rule list |
負荷分散規則を一覧表示します。 |
Core | GA |
| az network lb rule show |
負荷分散規則の詳細を取得します。 |
Core | GA |
| az network lb rule update |
負荷分散規則を更新します。 |
Core | GA |
| az network lb rule wait |
条件が満たされるまで CLI を待機状態にします。 |
Core | 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 --backend-pools-name]
[--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-floating-ip --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 --frontend-ip-name]
[--idle-timeout --idle-timeout-in-minutes]
[--load-distribution {Default, SourceIP, SourceIPProtocol}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--probe --probe-name]
例
アドレス プールとポートに対して前面向けの 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
必須のパラメーター
エンドポイントの内部接続に使用されるポート。 使用できる値は 0 ~ 65535 です。 値 0 では "任意のポート" が有効になります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
外部エンドポイントのポート。 各規則のポート番号は、ロード バランサー内で一意である必要があります。 使用できる値は 0 ~ 65534 です。 値 0 では "任意のポート" が有効になります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
ロード バランサー名。
負荷分散規則の名前。
負荷分散規則で使用されるトランスポート プロトコルへの参照。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | All, Tcp, Udp |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
バックエンド アドレス プールの ID または名前の一覧。 複数のプールは、ゲートウェイ SKU ロード バランサーでのみサポートされます。 1 つだけ存在する場合は、既定値として使用する場合は省略します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
負荷分散規則のフロントエンドで指定されたパブリック IP アドレスを使用するように、バックエンド プール内の VM の SNAT を構成します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
SQL AlwaysOn 可用性グループを構成するために必要なフローティング IP 機能用に仮想マシンのエンドポイントを構成します。 この設定は、SQL Server で SQL AlwaysOn 可用性グループを使用する場合に必要です。 エンドポイントを作成した後は、この設定を変更できません。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
TCP フローのアイドル タイムアウトまたは予期しない接続終了時に双方向 TCP リセットを受信します。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
フロントエンド IP 構成の ID の名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
TCP アイドル接続のタイムアウト。 値は 4 ~ 30 分の間で設定できます。 既定値は 4 分です。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
この規則の負荷分散ポリシー。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 規定値: | Default |
| 指定可能な値: | Default, SourceIP, SourceIPProtocol |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
この規則に関連付ける既存のプローブの ID または名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
必須のパラメーター
ロード バランサー名。
負荷分散規則の名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
必須のパラメーター
ロード バランサー名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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
必須のパラメーター
ロード バランサー名。
負荷分散規則の名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network lb rule update
負荷分散規則を更新します。
az network lb rule update --lb-name
--name
--resource-group
[--add]
[--backend-pool-name --backend-pools-name]
[--backend-port]
[--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-floating-ip --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-ip-name]
[--frontend-port]
[--idle-timeout --idle-timeout-in-minutes]
[--load-distribution {Default, SourceIP, SourceIPProtocol}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--probe --probe-name]
[--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
必須のパラメーター
ロード バランサー名。
負荷分散規則の名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
バックエンド アドレス プールの ID または名前の一覧。 複数のプールは、ゲートウェイ SKU ロード バランサーでのみサポートされます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
エンドポイントの内部接続に使用されるポート。 使用できる値は 0 ~ 65535 です。 値 0 では "任意のポート" が有効になります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
負荷分散規則のフロントエンドで指定されたパブリック IP アドレスを使用するように、バックエンド プール内の VM の SNAT を構成します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
SQL AlwaysOn 可用性グループを構成するために必要なフローティング IP 機能用に仮想マシンのエンドポイントを構成します。 この設定は、SQL Server で SQL AlwaysOn 可用性グループを使用する場合に必要です。 エンドポイントを作成した後は、この設定を変更できません。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
TCP フローのアイドル タイムアウトまたは予期しない接続終了時に双方向 TCP リセットを受信します。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
フロントエンド IP 構成の ID の名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
外部エンドポイントのポート。 各規則のポート番号は、ロード バランサー内で一意である必要があります。 使用できる値は 0 ~ 65534 です。 値 0 では "任意のポート" が有効になります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
TCP アイドル接続のタイムアウト。 値は 4 ~ 30 分の間で設定できます。 既定値は 4 分です。 この要素は、プロトコルが TCP に設定されている場合にのみ使用されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
この規則の負荷分散ポリシー。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | Default, SourceIP, SourceIPProtocol |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
この規則に関連付ける既存のプローブの ID または名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
負荷分散規則で使用されるトランスポート プロトコルへの参照。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
| 指定可能な値: | All, Tcp, Udp |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network lb rule wait
条件が満たされるまで CLI を待機状態にします。
az network lb rule wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--lb-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
ロード バランサー名。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
最大待機時間 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |