共用方式為

az eventgrid namespace topic

  • 預覽

Note

此參考是 Azure CLI 的 eventgrid 延伸模組的一部分（2.51.0 版或更高版本）。 擴充功能會在您第一次執行 az eventgrid 命名空間主題 命令時自動安裝。 深入了解擴充功能。

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

管理 eventgrid 命名空間主題。

命令

名稱 Description 類型 狀態
az eventgrid namespace topic create

建立新的命名空間主題。

 Extension Preview
az eventgrid namespace topic delete

刪除現有的命名空間主題。

 Extension Preview
az eventgrid namespace topic event-subscription

管理 eventgrid 命名空間主題事件訂用帳戶。

 Extension Preview
az eventgrid namespace topic event-subscription create

建立命名空間主題的事件訂用帳戶。

 Extension Preview
az eventgrid namespace topic event-subscription delete

刪除命名空間主題的現有事件訂用帳戶。

 Extension Preview
az eventgrid namespace topic event-subscription list

列出屬於特定命名空間主題的事件訂用帳戶。

 Extension Preview
az eventgrid namespace topic event-subscription show

顯示命名空間主題的事件訂用帳戶。

 Extension Preview
az eventgrid namespace topic event-subscription update

更新命名空間主題的事件訂閱。

 Extension Preview
az eventgrid namespace topic event-subscription wait

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

 Extension Preview
az eventgrid namespace topic list

列出命名空間下的所有命名空間主題。

 Extension Preview
az eventgrid namespace topic list-key

列出用來發佈至命名空間主題的兩個索引鍵。

 Extension Preview
az eventgrid namespace topic regenerate-key

重新產生命名空間主題的共用存取金鑰。

 Extension Preview
az eventgrid namespace topic show

顯示命名空間主題。

 Extension Preview
az eventgrid namespace topic update

更新命名空間主題。

 Extension Preview
az eventgrid namespace topic wait

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

 Extension Preview

az eventgrid namespace topic create

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立新的命名空間主題。

az eventgrid namespace topic create --name --topic-name
                                    --namespace-name
                                    --resource-group
                                    [--event-retention-in-days]
                                    [--input-schema {CloudEventSchemaV1_0}]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--publisher-type {Custom}]

範例

建立主題

az eventgrid namespace topic create -g rg -n topic --namespace-name name --event-retention-in-days 1 --publisher-type custom

必要參數

--name --topic-name -n

命名空間主題的名稱。

--namespace-name

命名空間的名稱。

--resource-group -g

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

選擇性參數

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

--event-retention-in-days

以天數表示之命名空間主題的事件保留期。

屬性 值
參數群組: Properties Arguments
--input-schema

這會決定發佈至主題之傳入事件的預期格式。

屬性 值
參數群組: Properties Arguments
預設值: CloudEventSchemaV1_0
接受的值: CloudEventSchemaV1_0
--no-wait

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

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

命名空間主題的發行者類型。

屬性 值
參數群組: Properties Arguments
接受的值: Custom
全域參數
--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 eventgrid namespace topic delete

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除現有的命名空間主題。

az eventgrid namespace topic delete [--ids]
                                    [--name --topic-name]
                                    [--namespace-name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

範例

刪除主題

az eventgrid namespace topic delete -g rg -n topic --namespace-name name

選擇性參數

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

--ids

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

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

主題的名稱。

屬性 值
參數群組: Resource Id Arguments
--namespace-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 eventgrid namespace topic list

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出命名空間下的所有命名空間主題。

az eventgrid namespace topic list --namespace-name
                                  --resource-group
                                  [--filter]
                                  [--max-items]
                                  [--next-token]
                                  [--top]

範例

清單主題

az eventgrid namespace topic list -g rg --namespace-name name

必要參數

--namespace-name

命名空間的名稱。

--resource-group -g

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

選擇性參數

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

--filter

用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 『name』 屬性，且 OData 作業數目有限。 這些作業包括：『contains』 函式以及下列邏輯作業：not、 和， 或 eq （針對 equal）， 和 ne （for not equal） 。 不支持算術運算。 以下是有效的篩選範例：$filter=contains（namE，'PATTERN'） 和名稱 ne 'PATTERN-1'。 下列不是有效的篩選範例：$filter=location eq 'westus'。

--max-items

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

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

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

屬性 值
參數群組: Pagination Arguments
--top

要針對清單作業傳回每個頁面的結果數目。 top 參數的有效範圍是 1 到 100。 如果未指定，每個頁面要傳回的默認結果數目為20個專案。

全域參數
--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 eventgrid namespace topic list-key

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出用來發佈至命名空間主題的兩個索引鍵。

az eventgrid namespace topic list-key [--ids]
                                      [--namespace-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--topic-name]

範例

清單索引鍵

az eventgrid namespace topic list-key -g rg --topic-name topic --namespace-name name

選擇性參數

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

--ids

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

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

主題的名稱。

屬性 值
參數群組: 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 eventgrid namespace topic regenerate-key

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

重新產生命名空間主題的共用存取金鑰。

az eventgrid namespace topic regenerate-key --key-name
                                            [--ids]
                                            [--namespace-name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--topic-name]

範例

重新產生金鑰

az eventgrid namespace topic regenerate-key -g rg --topic-name topic --namespace-name name --key-name key1

必要參數

--key-name

要重新產生key1或key2的金鑰名稱。

屬性 值
參數群組: RegenerateKeyRequest Arguments

選擇性參數

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

--ids

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

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

主題的名稱。

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

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

顯示命名空間主題。

az eventgrid namespace topic show [--ids]
                                  [--name --topic-name]
                                  [--namespace-name]
                                  [--resource-group]
                                  [--subscription]

範例

顯示主題

az eventgrid namespace topic show -g rg -n topic --namespace-name name

選擇性參數

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

--ids

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

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

命名空間主題的名稱。

屬性 值
參數群組: Resource Id Arguments
--namespace-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 eventgrid namespace topic update

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新命名空間主題。

az eventgrid namespace topic update [--add]
                                    [--event-retention-in-days]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--input-schema {CloudEventSchemaV1_0}]
                                    [--name --topic-name]
                                    [--namespace-name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--publisher-type {Custom}]
                                    [--remove]
                                    [--resource-group]
                                    [--set]
                                    [--subscription]

範例

更新主題

az eventgrid namespace topic create -g rg -n topic --namespace-name name --input-schema CloudEventSchemaV1_0

選擇性參數

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

--add

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

屬性 值
參數群組: Generic Update Arguments
--event-retention-in-days

以天數表示之命名空間主題的事件保留期。

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

這會決定發佈至主題之傳入事件的預期格式。

屬性 值
參數群組: Properties Arguments
接受的值: CloudEventSchemaV1_0
--name --topic-name -n

命名空間主題的名稱。

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

命名空間的名稱。

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

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

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

命名空間主題的發行者類型。

屬性 值
參數群組: Properties Arguments
接受的值: Custom
--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 eventgrid namespace topic wait

預覽

命令群組 'az eventgrid namespace topic' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

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

az eventgrid namespace topic wait [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--name --topic-name]
                                  [--namespace-name]
                                  [--resource-group]
                                  [--subscription]
                                  [--timeout]
                                  [--updated]

選擇性參數

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

--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 --topic-name -n

命名空間主題的名稱。

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