az webpubsub replica

Note

此參考是 Azure CLI 的 Webpubsub 擴充功能的一部分（2.56.0 版或更高版本）。當您第一次執行 az webpubsub replica 命令時，擴充功能會自動安裝。深入了解擴充功能。

管理複本設定。

命令

名稱	Description	類型	狀態
az webpubsub replica create	建立 Webpubsub 服務的複本。	Extension	GA
az webpubsub replica delete	刪除 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica list	列出 Webpubsub 服務的複本。	Extension	GA
az webpubsub replica restart	重新啟動 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica show	顯示複本的詳細數據。	Extension	GA
az webpubsub replica start	啟動 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica stop	停止 WebPubSub 服務的複本。	Extension	GA
az webpubsub replica update	更新 Webpubsub 服務的複本。	Extension	GA

az webpubsub replica create

建立 Webpubsub 服務的複本。

az webpubsub replica create --name
                            --replica-name
                            --resource-group
                            --sku
                            [--location]
                            [--tags]
                            [--unit-count]

範例

取得複本的詳細數據

az webpubsub replica create --sku Premium_P1 -l eastus --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

必要參數

--name -n

webpubsub 的名稱。

--replica-name

複本的名稱。

--resource-group -g

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

--sku

復本的 SKU 名稱。目前允許的值：Premium_P1。

選擇性參數

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

--location -l

Location. 值的來源：az account list-locations。您可以使用 az configure --defaults location=<location>來設定預設位置。

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--unit-count

webpubsub 服務單位計數。

屬性	值
預設值:	1

全域參數

--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 webpubsub replica delete

刪除 WebPubSub 服務的複本。

az webpubsub replica delete [--ids]
                            [--name]
                            [--replica-name]
                            [--resource-group]
                            [--subscription]

範例

刪除複本

az webpubsub replica delete --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	Resource Id Arguments

--replica-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 webpubsub replica list

列出 Webpubsub 服務的複本。

az webpubsub replica list --name
                          --resource-group

範例

取得複本的詳細數據

az webpubsub replica list --name MyWebPubSub -g MyResourceGroup -o table

必要參數

--name -n

webpubsub 的名稱。

--resource-group -g

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

全域參數

--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 webpubsub replica restart

重新啟動 WebPubSub 服務的複本。

az webpubsub replica restart [--ids]
                             [--name]
                             [--replica-name]
                             [--resource-group]
                             [--subscription]

範例

重新啟動複本

az webpubsub replica restart --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	Resource Id Arguments

--replica-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 webpubsub replica show

顯示複本的詳細數據。

az webpubsub replica show [--ids]
                          [--name]
                          [--replica-name]
                          [--resource-group]
                          [--subscription]

範例

取得複本的詳細數據

az webpubsub replica show --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	Resource Id Arguments

--replica-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 webpubsub replica start

啟動 WebPubSub 服務的複本。

az webpubsub replica start [--ids]
                           [--name]
                           [--replica-name]
                           [--resource-group]
                           [--subscription]

範例

啟動複本

az webpubsub replica start --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	Resource Id Arguments

--replica-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 webpubsub replica stop

停止 WebPubSub 服務的複本。

az webpubsub replica stop [--ids]
                          [--name]
                          [--replica-name]
                          [--resource-group]
                          [--subscription]

範例

停止複本

az webpubsub replica stop --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup

選擇性參數

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

--ids

屬性	值
參數群組:	Resource Id Arguments

--name -n

webpubsub 的名稱。

屬性	值
參數群組:	Resource Id Arguments

--replica-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 webpubsub replica update

更新 Webpubsub 服務的複本。

az webpubsub replica update --name
                            --replica-name
                            --resource-group
                            [--add]
                            [--force-string]
                            [--region-endpoint-enabled {false, true}]
                            [--remove]
                            [--set]
                            [--unit-count]

範例

啟用或停用 WebPubSub Service 複本的區域端點

az webpubsub replica update --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup --region-endpoint-enabled true

更新 WebPubSub Service 複本的單位計數

az webpubsub replica update --replica-name MyReplica --name MyWebPubSub -g MyResourceGroup --unit-count 2

必要參數

--name -n

webpubsub 的名稱。

--replica-name

複本的名稱。

--resource-group -g

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

選擇性參數

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

--add

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--force-string

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--region-endpoint-enabled

啟用或停用 WebPubSub 服務的區域端點。

屬性	值
接受的值:	false, true

--remove

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--set

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

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--unit-count

webpubsub 服務單位計數。

全域參數

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

命令

az webpubsub replica create

範例

必要參數

選擇性參數

az webpubsub replica delete

範例

選擇性參數

az webpubsub replica list

範例

必要參數

az webpubsub replica restart

範例

選擇性參數

az webpubsub replica show

範例

選擇性參數

az webpubsub replica start

範例

選擇性參數

az webpubsub replica stop

範例

選擇性參數

az webpubsub replica update

範例

必要參數

選擇性參數

意見反應