az notification-hub

注意

此參考是 Azure CLI 的通知中樞 延伸模組的一部分 (2.49.0 版或更高版本)。 擴充功能會在您第一次執行 az notification-hub 命令時自動安裝。 深入了解擴充功能。

此命令群組是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

管理通知中樞。

命令

名稱 Description 類型 狀態
az notification-hub authorization-rule

管理通知中樞授權規則的命令。

擴充 實驗性
az notification-hub authorization-rule create

建立通知中樞的授權規則。

擴充 實驗性
az notification-hub authorization-rule delete

刪除 notificationHub 授權規則。

擴充 實驗性
az notification-hub authorization-rule list

列出通知中樞的授權規則。

擴充 實驗性
az notification-hub authorization-rule list-keys

列出通知中樞的主要和次要連接字串。

擴充 實驗性
az notification-hub authorization-rule regenerate-keys

將主要/次要金鑰重新產生至通知中樞授權規則。

擴充 實驗性
az notification-hub authorization-rule show

依名稱顯示通知中樞的授權規則。

擴充 實驗性
az notification-hub check-availability

檢查命名空間中指定通知中樞的可用性。

擴充 實驗性
az notification-hub create

在命名空間中建立通知中樞。

擴充 實驗性
az notification-hub credential

管理通知中樞認證的命令。

擴充 實驗性
az notification-hub credential adm

管理通知中樞。

擴充 實驗性
az notification-hub credential adm update

更新 Amazon(ADM) 的認證。

擴充 實驗性
az notification-hub credential apns

管理通知中樞。

擴充 實驗性
az notification-hub credential apns update

更新 Apple(APNS) 的認證。

擴充 實驗性
az notification-hub credential baidu

管理通知中樞。

擴充 實驗性
az notification-hub credential baidu update

更新百度(Andrioid China)的認證。

擴充 實驗性
az notification-hub credential gcm

管理通知中樞。

擴充 實驗性
az notification-hub credential gcm update

更新 Google GCM/FCM API 金鑰。

擴充 實驗性
az notification-hub credential list

列出與通知中樞相關聯的 PNS 認證。

擴充 實驗性
az notification-hub credential mpns

管理通知中樞。

擴充 實驗性
az notification-hub credential mpns update

更新 Windows 電話(MPNS) 的認證。

擴充 實驗性
az notification-hub credential wns

管理通知中樞。

擴充 實驗性
az notification-hub credential wns update

更新 Windows(WNS) 的認證。

擴充 實驗性
az notification-hub delete

刪除與命名空間相關聯的通知中樞。

擴充 實驗性
az notification-hub list

列出與命名空間相關聯的通知中樞。

擴充 實驗性
az notification-hub namespace

管理通知中樞命名空間的命令。

擴充 實驗性
az notification-hub namespace authorization-rule

管理通知中樞命名空間授權規則的命令。

擴充 實驗性
az notification-hub namespace authorization-rule create

建立命名空間的授權規則。

擴充 實驗性
az notification-hub namespace authorization-rule delete

刪除命名空間授權規則。

擴充 實驗性
az notification-hub namespace authorization-rule list

列出命名空間的授權規則。

擴充 實驗性
az notification-hub namespace authorization-rule list-keys

列出命名空間的主要和次要連接字串。

擴充 實驗性
az notification-hub namespace authorization-rule regenerate-keys

重新產生主要/次要金鑰至命名空間授權規則。

擴充 實驗性
az notification-hub namespace authorization-rule show

依名稱取得命名空間的授權規則。

擴充 實驗性
az notification-hub namespace check-availability

檢查所有 Azure 訂用帳戶中指定服務命名空間的可用性。 這很實用,因為功能變數名稱是根據服務命名空間名稱所建立。

擴充 實驗性
az notification-hub namespace create

建立服務命名空間。 建立之後,此命名空間的資源資訊清單是不可變的。 此作業是等冪的。

擴充 實驗性
az notification-hub namespace delete

刪除現有的命名空間。 此作業也會移除命名空間下的所有相關聯 notificationHubs。

擴充 實驗性
az notification-hub namespace list

列出可用的命名空間。

擴充 實驗性
az notification-hub namespace show

傳回指定之命名空間的描述。

擴充 實驗性
az notification-hub namespace update

更新服務命名空間。 命名空間的資源資訊清單是不可變的,無法修改。

擴充 實驗性
az notification-hub namespace wait

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

擴充 實驗性
az notification-hub show

顯示通知中樞資訊。

擴充 實驗性
az notification-hub test-send

測試傳送推播通知。

擴充 實驗性
az notification-hub update

更新命名空間中的通知中樞。

擴充 實驗性

az notification-hub check-availability

實驗

命令群組 'notification-hub' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

檢查命名空間中指定通知中樞的可用性。

az notification-hub check-availability --name
                                       [--ids]
                                       [--namespace-name]
                                       [--resource-group]
                                       [--subscription]

範例

檢查指定通知中樞名稱的可用性

az notification-hub check-availability --resource-group MyResourceGroup --namespace-name "locp-newns" --name my-hub

必要參數

--name -n

資源名稱。

選擇性參數

--ids

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

--namespace-name

命名空間名稱。

--resource-group -g

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

--subscription

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az notification-hub create

實驗

命令群組 'notification-hub' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

在命名空間中建立通知中樞。

az notification-hub create --name
                           --namespace-name
                           --resource-group
                           [--location]
                           [--registration-ttl]
                           [--tags]

範例

建立通知中樞

az notification-hub create --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub --location "South Central US"

必要參數

--name -n

通知中樞名稱。

--namespace-name

命名空間名稱。

--resource-group -g

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

選擇性參數

--location -l

資源位置 未指定時,將會使用資源群組的位置。

--registration-ttl

所建立 NotificationHub 的 RegistrationTtl。

--tags

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az notification-hub delete

實驗

命令群組 'notification-hub' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

刪除與命名空間相關聯的通知中樞。

az notification-hub delete [--ids]
                           [--name]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]
                           [--yes]

範例

刪除通知中樞

az notification-hub delete --resource-group MyResourceGroup --namespace-name my-namespace --name my-hub

選擇性參數

--ids

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

--name -n

通知中樞名稱。

--namespace-name

命名空間名稱。

--resource-group -g

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

--subscription

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

--yes -y

不提示確認。

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

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az notification-hub list

實驗

命令群組 'notification-hub' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

列出與命名空間相關聯的通知中樞。

az notification-hub list --namespace-name
                         --resource-group
                         [--max-items]
                         [--next-token]

範例

列出通知中樞

az notification-hub list --resource-group MyResourceGroup --namespace-name my-namespace

必要參數

--namespace-name

命名空間名稱。

--resource-group -g

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

選擇性參數

--max-items

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

--next-token

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az notification-hub show

實驗

命令群組 'notification-hub' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

顯示通知中樞資訊。

az notification-hub show [--ids]
                         [--name]
                         [--namespace-name]
                         [--resource-group]
                         [--subscription]

選擇性參數

--ids

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

--name -n

通知中樞名稱。

--namespace-name

命名空間名稱。

--resource-group -g

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

--subscription

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az notification-hub test-send

實驗

命令群組 'notification-hub' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

測試傳送推播通知。

az notification-hub test-send --namespace-name
                              --notification-format {apple, baidu, gcm, template, windows, windowsphone}
                              --notification-hub-name
                              --resource-group
                              [--message]
                              [--payload]
                              [--tag]
                              [--title]

範例

測試傳送通知與訊息本文

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--message "test notification"

測試從檔案傳送通知

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--payload @path/to/file

測試使用 json 字串傳送通知

az notification-hub test-send --resource-group MyResourceGroup --namespace-name \
my-namespace --notification-hub-name my-hub --notification-format gcm \
--payload "{\"data\":{\"message\":\"test notification\"}}"

必要參數

--namespace-name

命名空間名稱。

--notification-format

通知訊息的格式。

接受的值: apple, baidu, gcm, template, windows, windowsphone
--notification-hub-name

通知中樞名稱。

--resource-group -g

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

選擇性參數

--message

要傳送的訊息本文。 如果不是 None,則會忽略承載。

--payload

JSON 格式訊息的承載。

--tag

您可以使用此選項,將測試通知傳送至一組特定的註冊。 如果您想要將推播通知傳送至所選平臺上的 10 個隨機註冊,請將此欄位保留空白。

--title

通知的標題。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az notification-hub update

實驗

命令群組 'notification-hub' 是實驗性且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

更新命名空間中的通知中樞。

az notification-hub update [--add]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--location]
                           [--name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--subscription]
                           [--tags]

範例

更新通知中樞

az notification-hub update --resource-group MyResourceGroup --namespace-name my-namespace --name "sdk-notificationHubs-8708"

選擇性參數

--add

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

--force-string

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

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

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

--location -l

資源位置。

--name --notification-hub-name -n

通知中樞名稱。

--namespace-name

命名空間名稱。

--remove

從清單中移除屬性或專案。 範例:--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--set

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

--subscription

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

--tags

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。