az network manager connect-config

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.61.0 or higher). 拡張機能は、az network manager connect-config コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

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

コマンド

名前	説明	型	状態
az network manager connect-config create	新しいネットワーク マネージャー接続構成を作成します。	Extension	GA
az network manager connect-config delete	リソース グループ、ネットワーク マネージャー名、接続構成名で指定されたネットワーク マネージャー接続構成を削除します。	Extension	GA
az network manager connect-config list	指定したネットワーク マネージャー内のすべてのネットワーク マネージャー接続構成を一覧表示します。	Extension	GA
az network manager connect-config show	リソース グループ、ネットワーク マネージャー名、接続構成名で指定されたネットワーク接続構成を取得します。	Extension	GA
az network manager connect-config update	新しいネットワーク マネージャー接続構成を更新します。	Extension	GA
az network manager connect-config wait	条件が満たされるまで CLI を待機状態にします。	Extension	GA

az network manager connect-config create

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

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

例

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

az network manager connect-config create --configuration-name "myTestConnectivityConfig" --description "Sample Configuration" --applies-to-group 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/Micr osoft.Network/virtualNetworks/myTestConnectivityConfig" resource- type="Microsoft.Network/virtualNetworks" --is-global true --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

必須のパラメーター

--configuration-name

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

--name --network-manager-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.

--applies-to-group --applies-to-groups

構成のグループ 短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。 単数形のフラグ: --applies-to-group。

プロパティ	値
Parameter group:	Properties Arguments

--connectivity-topology

接続トポロジの種類。

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	HubAndSpoke, Mesh

--delete-existing-peering

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

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	False, True

--description

接続構成の説明。

プロパティ	値
Parameter group:	Properties Arguments

--hub --hubs

hubItems の一覧では、短縮構文、json-file、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。 単数形のフラグ: --hub。

プロパティ	値
Parameter group:	Properties Arguments

--is-global

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

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	False, True

グローバル パラメーター

--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 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 --network-manager-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"

省略可能のパラメーター

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

--configuration-name

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

プロパティ	値
Parameter group:	Resource Id Arguments

--force

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

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

--ids

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

プロパティ	値
Parameter group:	Resource Id Arguments

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

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

プロパティ	値
Parameter group:	Resource Id Arguments

--no-wait

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

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

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

--yes -y

確認を求めないでください。

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

az network manager connect-config list

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

az network manager connect-config list --name --network-manager-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>を使用して既定のグループを構成できます。

省略可能のパラメーター

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

--max-items

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

プロパティ	値
Parameter group:	Pagination Arguments

--next-token

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

プロパティ	値
Parameter group:	Pagination Arguments

--skip-token

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

--top

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

グローバル パラメーター

--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 manager connect-config show

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

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

例

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

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

省略可能のパラメーター

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

--configuration-name

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

プロパティ	値
Parameter group:	Resource Id Arguments

--ids

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

プロパティ	値
Parameter group:	Resource Id Arguments

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

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

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

グローバル パラメーター

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

az network manager connect-config update

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

az network manager connect-config update [--add]
                                         [--applies-to-group --applies-to-groups]
                                         [--configuration-name]
                                         [--connectivity-topology {HubAndSpoke, Mesh}]
                                         [--delete-existing-peering {False, True}]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--hub --hubs]
                                         [--ids]
                                         [--is-global {False, True}]
                                         [--name --network-manager-name]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]

省略可能のパラメーター

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

--applies-to-group --applies-to-groups

構成のグループ 短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。 単数形のフラグ: --applies-to-group。

プロパティ	値
Parameter group:	Properties Arguments

--configuration-name

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

プロパティ	値
Parameter group:	Resource Id Arguments

--connectivity-topology

接続トポロジの種類。

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	HubAndSpoke, Mesh

--delete-existing-peering

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

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	False, True

--description

接続構成の説明。

プロパティ	値
Parameter group:	Properties Arguments

--force-string

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

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

--hub --hubs

hubItems の一覧では、短縮構文、json-file、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。 単数形のフラグ: --hub。

プロパティ	値
Parameter group:	Properties Arguments

--ids

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

プロパティ	値
Parameter group:	Resource Id Arguments

--is-global

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

プロパティ	値
Parameter group:	Properties Arguments
指定可能な値:	False, True

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

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

プロパティ	値
Parameter group:	Resource Id Arguments

--remove

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

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

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--set

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

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

--subscription

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

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

--verbose

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

プロパティ	値
規定値:	False

az network manager connect-config wait

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

az network manager connect-config wait [--configuration-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name --network-manager-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.

--configuration-name

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

プロパティ	値
Parameter group:	Resource Id Arguments

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

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

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

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