az network local-gateway

  • リファレンス

ローカル ゲートウェイを管理します。

ローカル ゲートウェイの詳細については、以下を参照してください https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli#localnet。

コマンド

名前 説明 型 Status
az network local-gateway create

ローカル VPN ゲートウェイを作成します。

 コア GA
az network local-gateway delete

ローカル VPN ゲートウェイを削除します。

 コア GA
az network local-gateway list

リソース グループ内のすべてのローカル VPN ゲートウェイを一覧表示します。

 コア GA
az network local-gateway show

ローカル VPN ゲートウェイの詳細を取得します。

 コア GA
az network local-gateway update

ローカル VPN ゲートウェイを更新します。

 コア GA
az network local-gateway wait

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

 コア GA

az network local-gateway create

編集

ローカル VPN ゲートウェイを作成します。

az network local-gateway create --name
                                --resource-group
                                [--address-prefixes]
                                [--asn]
                                [--bgp-peering-address]
                                [--gateway-ip-address]
                                [--location]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--peer-weight]
                                [--tags]

例

オンプレミス サイトを表すローカル ネットワーク ゲートウェイを作成します。

az network local-gateway create -g MyResourceGroup -n MyLocalGateway --gateway-ip-address 23.99.221.164 --local-address-prefixes 10.0.0.0/24 20.0.0.0/24

必須のパラメーター

--name -n

ローカル ネットワーク ゲートウェイの名前。

--resource-group -g

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

省略可能のパラメーター

--address-prefixes --local-address-prefixes

OnPremise VPN のサブネットのアドレス空間を表す CIDR ブロック プレフィックスの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--asn

BGP 設定に使用する自律システム番号。

--bgp-peering-address

BGP ピアリングに使用する OnPremise VPN のサブネットからの IP アドレス。

--gateway-ip-address

ゲートウェイのパブリック IP アドレス。 (例: 10.1.1.1)。

--location -l

場所。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--peer-weight

BGP ピアリングを通じて学習されたルートに加えられた重み (0 から 100)。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--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 local-gateway delete

編集

ローカル VPN ゲートウェイを削除します。

ローカル ネットワーク ゲートウェイを削除するには、まず、ゲートウェイに接続されている Azure 内のすべての接続オブジェクトを削除する必要があります。 ゲートウェイを削除した後、使用されていない他のリソースの削除に進みます。 詳細については、このページ https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-delete-vnet-gateway-portalの指示の順序に従ってください。

az network local-gateway delete [--ids]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--resource-group]
                                [--subscription]

例

ローカル ネットワーク ゲートウェイを削除します。

az network local-gateway delete -g MyResourceGroup -n MyLocalGateway

ローカル VPN ゲートウェイを削除します。 (自動生成)

az network local-gateway delete --name MyLocalGateway --resource-group MyResourceGroup --subscription MySubscription

省略可能のパラメーター

--ids

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

--name -n

ローカル ネットワーク ゲートウェイの名前。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_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 local-gateway list

編集

リソース グループ内のすべてのローカル VPN ゲートウェイを一覧表示します。

az network local-gateway list --resource-group

例

リソース グループ内のすべてのローカル VPN ゲートウェイを一覧表示します。

az network local-gateway list -g MyResourceGroup

必須のパラメーター

--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 local-gateway show

編集

ローカル VPN ゲートウェイの詳細を取得します。

az network local-gateway show [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

例

ローカル VPN ゲートウェイの詳細を取得します。

az network local-gateway show -g MyResourceGroup -n MyLocalGateway

省略可能のパラメーター

--ids

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

--name -n

ローカル ネットワーク ゲートウェイの名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_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 local-gateway update

編集

ローカル VPN ゲートウェイを更新します。

az network local-gateway update [--add]
                                [--address-prefixes]
                                [--asn]
                                [--bgp-peering-address]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--gateway-ip-address]
                                [--ids]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--peer-weight]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]
                                [--tags]

例

10.0.0.0/24 アドレス プレフィックスでプロビジョニングされたローカル ネットワーク ゲートウェイを、追加のプレフィックスで更新します。

az network local-gateway update -g MyResourceGroup -n MyLocalGateway --address-prefixes 10.0.0.0/24 20.0.0.0/24 30.0.0.0/24

ローカル VPN ゲートウェイを更新します。 (自動生成)

az network local-gateway update --gateway-ip-address 23.99.221.164 --name MyLocalGateway --resource-group MyResourceGroup

省略可能のパラメーター

--add

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

--address-prefixes --local-address-prefixes

OnPremise VPN のサブネットのアドレス空間を表す CIDR ブロック プレフィックスの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--asn

BGP 設定に使用する自律システム番号。

--bgp-peering-address

BGP ピアリングに使用する OnPremise VPN のサブネットからの IP アドレス。

--force-string

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--gateway-ip-address

ゲートウェイのパブリック IP アドレス。 (例: 10.1.1.1)。

--ids

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

--name -n

ローカル ネットワーク ゲートウェイの名前。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--peer-weight

BGP ピアリングを通じて学習されたルートに加えられた重み (0 から 100)。

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--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 local-gateway wait

編集

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

az network local-gateway wait [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--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
--name -n

ローカル ネットワーク ゲートウェイの名前。

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