共用方式為

az networkcloud clustermanager

Note

此參考是 Azure CLI （2.75.0 版或更新版本） 的 networkcloud 延伸模組的一部分。 擴充功能會在您第一次執行 az networkcloud clustermanager 命令時自動安裝。 深入了解擴充功能。

管理叢集管理員。

命令

名稱 Description 類型 狀態
az networkcloud clustermanager create

如果叢集管理員存在，請建立新的叢集管理員或更新叢集管理員的屬性。

 Extension Preview
az networkcloud clustermanager delete

刪除提供的叢集管理員。

 Extension Preview
az networkcloud clustermanager identity

管理叢集管理員的身分識別。

 Extension GA
az networkcloud clustermanager identity assign

指派用戶或系統受控識別。

 Extension GA
az networkcloud clustermanager identity remove

拿掉使用者或系統受控識別。

 Extension GA
az networkcloud clustermanager identity show

顯示受控識別的詳細數據。

 Extension GA
az networkcloud clustermanager identity wait

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

 Extension GA
az networkcloud clustermanager list

列出所提供資源群組或訂用帳戶中的叢集管理員。

 Extension Preview
az networkcloud clustermanager show

取得所提供叢集管理員的屬性。

 Extension Preview
az networkcloud clustermanager update

更新所提供叢集管理員的屬性，或更新指派給叢集管理員的標籤。 屬性和標籤更新可以獨立完成。

 Extension Preview
az networkcloud clustermanager wait

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

 Extension GA

az networkcloud clustermanager create

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

如果叢集管理員存在，請建立新的叢集管理員或更新叢集管理員的屬性。

az networkcloud clustermanager create --cluster-manager-name --name
                                      --fabric-controller-id
                                      --resource-group
                                      [--analytics-workspace-id]
                                      [--availability-zones]
                                      [--if-match]
                                      [--if-none-match]
                                      [--location]
                                      [--managed-resource-group-configuration --mrg]
                                      [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--mi-user-assigned]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--tags]
                                      [--vm-size]

範例

建立或更新叢集管理員

az networkcloud clustermanager create --name "clusterManagerName" --location "location" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" --managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

使用系統指派的身分識別建立或更新叢集管理員

az networkcloud clustermanager create --name "clusterManagerName" --location "location" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" --managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --mi-system-assigned

使用使用者指派的身分識別建立或更新叢集管理員

az networkcloud clustermanager create --name "clusterManagerName" --location "location" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" --managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"

使用提供的 VM SKU 和可用性區域建立或更新叢集管理員

az networkcloud clustermanager create --name "clusterManagerName" --location "location" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" --managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --vm-size Standard_D8s_v3 --availability-zones "[2,3]"

必要參數

--cluster-manager-name --name -n

叢集管理員的名稱。

--fabric-controller-id

與叢集管理員有一對一對應之網狀架構控制器的資源標識碼。

屬性 值
參數群組: Properties Arguments
--resource-group -g

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

選擇性參數

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

--analytics-workspace-id

用於記錄收集之Log Analytics工作區的資源標識碼。

屬性 值
參數群組: Properties Arguments
--availability-zones

將用來支援叢集管理員資源之區域內的 Azure 可用性區域。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

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

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

--if-none-match

設定為 『*』 以允許建立新的記錄集，但為了避免更新現有的資源。 其他值會導致伺服器發生錯誤，因為它們不受支援。

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

屬性 值
參數群組: ClusterManagerParameters Arguments
--managed-resource-group-configuration --mrg

與資源相關聯的受控資源群組組態。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: Properties Arguments
--mi-system-assigned

啟用系統指派的身分識別。

屬性 值
參數群組: Managed Identity Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

空間分隔的資源標識碼，以新增使用者指派的身分識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: Managed Identity Arguments
--no-wait

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

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

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: ClusterManagerParameters Arguments
--vm-size

用來裝載叢集管理員資源的 Azure 虛擬機大小。

屬性 值
參數群組: Properties Arguments
全域參數
--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 networkcloud clustermanager delete

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除提供的叢集管理員。

az networkcloud clustermanager delete [--cluster-manager-name --name]
                                      [--ids]
                                      [--if-match]
                                      [--if-none-match]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--yes]

範例

刪除叢集管理員

az networkcloud clustermanager delete --name "clusterManagerName" --resource-group "resourceGroupName"

選擇性參數

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

--cluster-manager-name --name -n

叢集管理員的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

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

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

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

--if-none-match

設定為 『*』 以允許建立新的記錄集，但為了避免更新現有的資源。 其他值會導致伺服器發生錯誤，因為它們不受支援。

--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 networkcloud clustermanager list

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出所提供資源群組或訂用帳戶中的叢集管理員。

az networkcloud clustermanager list [--max-items]
                                    [--next-token]
                                    [--resource-group]
                                    [--skip-token]
                                    [--top]

範例

列出訂用帳戶的叢集管理員

az networkcloud clustermanager list

列出資源群組的叢集管理員

az networkcloud clustermanager list --resource-group "resourceGroupName"

選擇性參數

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

--max-items

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

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

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

屬性 值
參數群組: Pagination Arguments
--resource-group -g

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

--skip-token

伺服器傳回的不透明記號，以指出要從何處繼續列出資源。 這用於分頁大型結果集。

--top

從作業傳回的資源數目上限。 範例：「$top=10」。

全域參數
--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 networkcloud clustermanager show

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得所提供叢集管理員的屬性。

az networkcloud clustermanager show [--cluster-manager-name --name]
                                    [--ids]
                                    [--resource-group]
                                    [--subscription]

範例

取得叢集管理員

az networkcloud clustermanager show --name "clusterManagerName" --resource-group "resourceGroupName"

選擇性參數

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

--cluster-manager-name --name -n

叢集管理員的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

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

屬性 值
參數群組: 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 networkcloud clustermanager update

預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新所提供叢集管理員的屬性，或更新指派給叢集管理員的標籤。 屬性和標籤更新可以獨立完成。

az networkcloud clustermanager update [--cluster-manager-name --name]
                                      [--ids]
                                      [--if-match]
                                      [--if-none-match]
                                      [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--mi-user-assigned]
                                      [--resource-group]
                                      [--subscription]
                                      [--tags]

範例

更新叢集管理員的標籤

az networkcloud clustermanager update --name "clusterManagerName" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

將系統指派的身分識別新增至叢集管理員

az networkcloud clustermanager update --name "clusterManagerName" --resource-group "resourceGroupName" --mi-system-assigned

將使用者指派的身分識別新增至叢集管理員

az networkcloud clustermanager update --name "clusterManagerName" --resource-group "resourceGroupName" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"

選擇性參數

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

--cluster-manager-name --name -n

叢集管理員的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

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

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

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

--if-none-match

設定為 『*』 以允許建立新的記錄集，但為了避免更新現有的資源。 其他值會導致伺服器發生錯誤，因為它們不受支援。

--mi-system-assigned

啟用系統指派的身分識別。

屬性 值
參數群組: Managed Identity Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

空間分隔的資源標識碼，以新增使用者指派的身分識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: Managed Identity Arguments
--resource-group -g

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

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

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

屬性 值
參數群組: Resource Id Arguments
--tags

將取代現有資源的 Azure 資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: ClusterManagerUpdateParameters 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 networkcloud clustermanager wait

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

az networkcloud clustermanager wait [--cluster-manager-name --name]
                                    [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]

選擇性參數

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

--cluster-manager-name --name -n

叢集管理員的名稱。

屬性 值
參數群組: Resource Id 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
--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