az network manager group

Note

此參考文獻是Azure CLI virtual-network-manager擴充套件(版本 2.75.0 或更高版本)的一部分。 擴充功能會在您第一次執行 az network manager group 命令時自動安裝。 深入了解擴充功能。

使用網路管理網路群組。

命令

名稱 Description 類型 狀態
az network manager group create

建立網路群組。

Extension GA
az network manager group delete

刪除網路群組。

Extension GA
az network manager group list

列出指定的網路群組。

Extension GA
az network manager group show

取得指定的網路群組。

Extension GA
az network manager group static-member

使用網路管理員群組管理靜態成員。

Extension GA
az network manager group static-member create

建立靜態成員。

Extension GA
az network manager group static-member delete

刪除靜態成員。

Extension GA
az network manager group static-member list

列出特定網路群組內的靜態成員。

Extension GA
az network manager group static-member show

取得指定的靜態成員。

Extension GA
az network manager group update

更新網路群組。

Extension GA
az network manager group wait

將 CLI 置於等候狀態,直到符合條件為止。

Extension GA

az network manager group create

建立網路群組。

az network manager group create --name --network-group-name
                                --network-manager-name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--description]
                                [--if-match]
                                [--member-type {Subnet, VirtualNetwork}]

範例

Create/Update Azure Virtual Network Manager Network Group

az network manager group create --name "TestNetworkGroup" --network-manager-name "testNetworkManager" --description "A sample group" --resource-group "rg1"

必要參數

--name --network-group-name -n

網路群組的名稱。

--network-manager-name

網路管理員的名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--description

網路群組的描述。

屬性
參數群組: Properties Arguments
--if-match

轉換的ETag。 請省略此值以一律覆寫目前的資源。 指定最後看到的 ETag 值,以防止意外覆寫並行變更。

--member-type

群組成員的類型。

屬性
參數群組: Properties Arguments
接受的值: Subnet, VirtualNetwork
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az network manager group delete

刪除網路群組。

az network manager group delete [--acquire-policy-token]
                                [--change-reference]
                                [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--name --network-group-name]
                                [--network-manager-name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--resource-group]
                                [--subscription]
                                [--yes]

範例

Delete Azure Virtual Network Manager Group

az network manager group delete --name "TestNetworkGroup" --network-manager-name "testNetworkManager" --resource-group "rg1" --force

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--force

即使資源是已部署組態的一部分,也會刪除資源。 如果已部署組態,服務會在刪除之前,在背景中執行清除部署。

屬性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name --network-group-name -n

網路群組的名稱。

屬性
參數群組: Resource Id Arguments
--network-manager-name

網路管理員的名稱。

屬性
參數群組: Resource Id Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
--yes -y

請勿提示確認。

屬性
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az network manager group list

列出指定的網路群組。

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

範例

List Azure Virtual Network Manager Network Groups

az network manager group list --network-manager-name "testNetworkManager" --resource-group "rg1"

必要參數

--network-manager-name

網路管理員的名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值,則會在命令的輸出中提供令牌。 若要繼續分頁,請在後續命令的 --next-token 自變數中提供令牌值。

屬性
參數群組: Pagination Arguments
--next-token

標記,指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

屬性
參數群組: Pagination Arguments
--skip-token

只有在先前的作業傳回部分結果時,才會使用SkipToken。 如果先前的回應包含 nextLink 元素,則 nextLink 元素的值會包含 skipToken 參數,指定用於後續呼叫的起點。

--top

選擇性的查詢參數,指定要由伺服器傳回的記錄數目上限。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az network manager group show

取得指定的網路群組。

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

範例

Get Azure Virtual Network Manager Network Group

az network manager group show --name "TestNetworkGroup" --network-manager-name "testNetworkManager" --resource-group "rg1"

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--name --network-group-name -n

網路群組的名稱。

屬性
參數群組: Resource Id Arguments
--network-manager-name

網路管理員的名稱。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az network manager group update

更新網路群組。

az network manager group update [--acquire-policy-token]
                                [--add]
                                [--change-reference]
                                [--description]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--if-match]
                                [--member-type {Subnet, VirtualNetwork}]
                                [--name --network-group-name]
                                [--network-manager-name]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--add

藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>.

屬性
參數群組: Generic Update Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--description

網路群組的描述。

屬性
參數群組: Properties Arguments
--force-string

使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。

屬性
參數群組: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--if-match

轉換的ETag。 請省略此值以一律覆寫目前的資源。 指定最後看到的 ETag 值,以防止意外覆寫並行變更。

--member-type

群組成員的類型。

屬性
參數群組: Properties Arguments
接受的值: Subnet, VirtualNetwork
--name --network-group-name -n

網路群組的名稱。

屬性
參數群組: Resource Id Arguments
--network-manager-name

網路管理員的名稱。

屬性
參數群組: Resource Id Arguments
--remove

從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>--remove propertyToRemove

屬性
參數群組: Generic Update Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--set

指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>.

屬性
參數群組: Generic Update Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False

az network manager group wait

將 CLI 置於等候狀態,直到符合條件為止。

az network manager group wait [--acquire-policy-token]
                              [--change-reference]
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--name --network-group-name]
                              [--network-manager-name]
                              [--resource-group]
                              [--subscription]
                              [--timeout]
                              [--updated]

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性
參數群組: Wait Condition Arguments
預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

屬性
參數群組: Wait Condition Arguments
--deleted

等到刪除為止。

屬性
參數群組: Wait Condition Arguments
預設值: False
--exists

等候資源存在。

屬性
參數群組: Wait Condition Arguments
預設值: False
--ids

一或多個資源識別碼(以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性
參數群組: Resource Id Arguments
--interval

輪詢間隔以秒為單位。

屬性
參數群組: Wait Condition Arguments
預設值: 30
--name --network-group-name -n

網路群組的名稱。

屬性
參數群組: Resource Id Arguments
--network-manager-name

網路管理員的名稱。

屬性
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性
參數群組: Resource Id Arguments
--timeout

以秒為單位的等候上限。

屬性
參數群組: Wait Condition Arguments
預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

屬性
參數群組: Wait Condition Arguments
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性
預設值: False
--output -o

輸出格式。

屬性
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False