az network manager connect-config

  • リファレンス

Note

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

ネットワークを使用して接続構成を管理します。

コマンド

名前 説明 型 Status
az network manager connect-config create

新しいネットワーク マネージャー接続構成を作成します。

 拡張機能 GA
az network manager connect-config delete

リソース グループ、ネットワーク マネージャー名、接続構成名で指定されたネットワーク マネージャー接続構成を削除します。

 拡張機能 GA
az network manager connect-config list

指定したネットワーク マネージャー内のすべてのネットワーク マネージャー接続構成を一覧表示します。

 拡張機能 GA
az network manager connect-config show

リソース グループ、ネットワーク マネージャー名、接続構成名で指定されたネットワーク接続構成を取得します。

 拡張機能 GA
az network manager connect-config update

新しいネットワーク マネージャー接続構成を更新します。

 拡張機能 GA
az network manager connect-config wait

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

 拡張機能 GA

az network manager connect-config create

新しいネットワーク マネージャー接続構成を作成します。

az network manager connect-config create --applies-to-groups
                                         --configuration-name
                                         --connectivity-topology {HubAndSpoke, Mesh}
                                         --name
                                         --resource-group
                                         [--delete-existing-peering {false, true}]
                                         [--description]
                                         [--hub]
                                         [--is-global {false, true}]

例

Azure Virtual Network Manager の接続構成の作成/更新

az network manager connect-config create --configuration-name "myTestConnectivityConfig" --description "Sample Configuration" --applies-to-groups group-connectivity="None" is-global=false network-group-id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkManagerGroups/group1" use-hub-gateway=true --connectivity-topology "HubAndSpoke" --delete-existing-peering true --hub resource-id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig" resource-type="Microsoft.Network/virtualNetworks" --is-global true --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

必須のパラメーター

--applies-to-groups

構成のグループ。

使用法: --applies-to-groups network-group-id=XX use-hub-gateway=XX is-global=XX group-connectivity=XX

network-group-id: ネットワーク グループ ID。use-hub-gateway: ハブ ゲートウェイを使用する必要がある場合はフラグを設定します。 トポロジがハブ アンド スポークの場合にのみ必要です。 is-global: グローバルがサポートされている場合はフラグを設定します。 トポロジがハブ アンド スポークの場合にのみ必要です。 group-connectivity: グループ接続の種類。 トポロジがハブ アンド スポークの場合にのみ必要です。 使用できる値: None、DirectlyConnected

複数のアクションを指定するには、複数の --applies-to-groups 引数を使用します。

--configuration-name

ネットワーク マネージャーの接続構成の名前。

--connectivity-topology

接続トポロジの種類。

承認された値: HubAndSpoke, Mesh
--name --network-manager-name -n

ネットワーク マネージャーの名前。

--resource-group -g

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

省略可能のパラメーター

--delete-existing-peering

現在の既存のピアリングを削除する必要がある場合はフラグを設定します。

承認された値: false, true
--description

接続構成の説明。

--hub

ハブ vnet。

使用法: --hub resource-id=XX resource-type=XX

resource-id: Resource ID resource-type: Resource type, suggested value(s): 'Microsoft.Network/virtualNetworks'.

--is-global

グローバル メッシュがサポートされている場合はフラグを設定します。

承認された値: false, true
グローバル パラメーター
--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 manager connect-config delete

リソース グループ、ネットワーク マネージャー名、接続構成名で指定されたネットワーク マネージャー接続構成を削除します。

az network manager connect-config delete [--configuration-name]
                                         [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

例

Azure Virtual Network Manager の接続構成を削除する

az network manager connect-config delete --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

省略可能のパラメーター

--configuration-name

ネットワーク マネージャーの接続構成の名前。

--force

デプロイされた構成の一部である場合でも、リソースを削除します。 構成がデプロイされている場合、サービスは削除の前にバックグラウンドでクリーンup デプロイを実行します。

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

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

--name --network-manager-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 を使用して、既定のサブスクリプションを構成できます。

--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 network manager connect-config list

指定したネットワーク マネージャー内のすべてのネットワーク マネージャー接続構成を一覧表示します。

az network manager connect-config list --name
                                       --resource-group
                                       [--max-items]
                                       [--next-token]
                                       [--skip-token]
                                       [--top]

例

Azure Virtual Network Manager の Connecitivity 構成を一覧表示する

az network manager connect-config list --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

必須のパラメーター

--name --network-manager-name -n

ネットワーク マネージャーの名前。

--resource-group -g

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

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

--skip-token

SkipToken は、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skipToken パラメーターが含まれます。

--top

サーバーから返されるレコードの最大数を指定する省略可能なクエリ パラメーター。

グローバル パラメーター
--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 manager connect-config show

リソース グループ、ネットワーク マネージャー名、接続構成名で指定されたネットワーク接続構成を取得します。

az network manager connect-config show [--configuration-name]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

例

Azure Virtual Network Manager の接続構成を取得する

az network manager connect-config show --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

省略可能のパラメーター

--configuration-name

ネットワーク マネージャーの接続構成の名前。

--ids

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

--name --network-manager-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 manager connect-config update

新しいネットワーク マネージャー接続構成を更新します。

az network manager connect-config update [--applies-to-groups]
                                         [--configuration-name]
                                         [--delete-existing-peering {false, true}]
                                         [--description]
                                         [--hub]
                                         [--ids]
                                         [--is-global {false, true}]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]

省略可能のパラメーター

--applies-to-groups

構成のグループ。

使用法: --applies-to-groups network-group-id=XX use-hub-gateway=XX is-global=XX group-connectivity=XX

network-group-id: ネットワーク グループ ID。use-hub-gateway: ハブ ゲートウェイを使用する必要がある場合はフラグを設定します。 トポロジがハブ アンド スポークの場合にのみ必要です。 is-global: グローバルがサポートされている場合はフラグを設定します。 トポロジがハブ アンド スポークの場合にのみ必要です。 group-connectivity: グループ接続の種類。 トポロジがハブ アンド スポークの場合にのみ必要です。 使用できる値: None、DirectlyConnected

複数のアクションを指定するには、複数の --applies-to-groups 引数を使用します。

--configuration-name

ネットワーク マネージャーの接続構成の名前。

--delete-existing-peering

現在の既存のピアリングを削除する必要がある場合はフラグを設定します。

承認された値: false, true
--description

接続構成の説明。

--hub

ハブ vnet。

使用法: --hub resource-id=XX resource-type=XX

resource-id: Resource ID resource-type: Resource type, suggested value(s): 'Microsoft.Network/virtualNetworks'.

--ids

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

--is-global

グローバル メッシュがサポートされている場合はフラグを設定します。

承認された値: false, true
--name --network-manager-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 manager connect-config wait

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

az network manager connect-config wait [--configuration-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

省略可能のパラメーター

--configuration-name

ネットワーク マネージャーの接続構成の名前。

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