共用方式為

az webpubsub key

Note

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

管理 Webpubsub 金鑰的命令。

命令

名稱 Description 類型 狀態
az webpubsub key regenerate

重新產生 WebPubSub 服務的金鑰。

 Extension GA
az webpubsub key show

顯示 WebPubSub 服務的串連字串和索引鍵。

 Extension GA

az webpubsub key regenerate

重新產生 WebPubSub 服務的金鑰。

az webpubsub key regenerate --key-type {primary, salt, secondary}
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

範例

重新產生 WebPubSub 服務的主鍵。

az webpubsub key regenerate -n MyWebPubSub -g MyResourceGroup --key-type primary --query primaryKey -o tsv

必要參數

--key-type

要重新產生之存取金鑰的名稱。

屬性 值
接受的值: primary, salt, secondary

選擇性參數

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

--ids

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

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

webpubsub 的名稱。

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

顯示 WebPubSub 服務的串連字串和索引鍵。

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

範例

取得 WebPubSub 服務的主鍵。

az webpubsub key show -n MyWebPubSub -g MyResourceGroup --query primaryKey -o tsv

選擇性參數

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

--ids

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

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

webpubsub 的名稱。

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