az eventhubs eventhub

管理 Azure EventHubs eventhub 和授權規則。

命令

名稱	Description	類型	狀態
az eventhubs eventhub authorization-rule	Eventhub 授權規則。	核心	GA
az eventhubs eventhub authorization-rule create	為指定的事件中樞建立 AuthorizationRule。 AuthorizationRule 的建立/更新需要幾秒鐘的時間才會生效。	核心	GA
az eventhubs eventhub authorization-rule delete	刪除事件中樞 AuthorizationRule。	核心	GA
az eventhubs eventhub authorization-rule keys	授權規則金鑰。	核心	GA
az eventhubs eventhub authorization-rule keys list	取得事件中樞的 ACS 和 SAS 連接字串。	核心	GA
az eventhubs eventhub authorization-rule keys renew	重新產生事件中樞的 ACS 和 SAS 連接字串。	核心	GA
az eventhubs eventhub authorization-rule list	列出事件中樞的授權規則。	核心	GA
az eventhubs eventhub authorization-rule show	依規則名稱取得事件中樞的 AuthorizationRule。	核心	GA
az eventhubs eventhub authorization-rule update	更新指定事件中樞的 AuthorizationRule。 AuthorizationRule 的建立/更新需要幾秒鐘的時間才會生效。	核心	GA
az eventhubs eventhub consumer-group	管理 Azure 事件中樞取用者群組。	核心	GA
az eventhubs eventhub consumer-group create	建立事件中樞取用者群組作為命名空間內的巢狀資源。	核心	GA
az eventhubs eventhub consumer-group delete	從指定的事件中樞和資源群組中刪除取用者群組。	核心	GA
az eventhubs eventhub consumer-group list	列出命名空間中的所有取用者群組。 如果命名空間中沒有任何取用者群組存在，則會傳回空白摘要。	核心	GA
az eventhubs eventhub consumer-group show	取得指定取用者群組的描述。	核心	GA
az eventhubs eventhub consumer-group update	將事件中樞取用者群組更新為命名空間內的巢狀資源。	核心	GA
az eventhubs eventhub create	建立 EventHubs Eventhub。	核心	GA
az eventhubs eventhub delete	從指定的命名空間和資源群組中刪除事件中樞。	核心	GA
az eventhubs eventhub list	列出命名空間中的所有事件中樞。	核心	GA
az eventhubs eventhub show	取得指定事件中樞的事件中樞描述。	核心	GA
az eventhubs eventhub update	將新的事件中樞更新為命名空間內的巢狀資源。	核心	GA

az eventhubs eventhub create

建立 EventHubs Eventhub。

az eventhubs eventhub create --name
                             --namespace-name
                             --resource-group
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--mi-system-assigned {false, true}]
                             [--mi-user-assigned]
                             [--min-compaction-lag-in-mins]
                             [--partition-count]
                             [--retention-time]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

範例

建立新的 Eventhub。

az eventhubs eventhub create --resource-group myresourcegroup --namespace-name mynamespace --name myeventhub --cleanup-policy Delete --partition-count 15

必要參數

--name -n

Eventhub 的名稱。

--namespace-name

命名空間的名稱。

--resource-group -g

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

選擇性參數

--archive-name-format

封存的 Blob 命名慣例，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 在這裡，所有參數 （Namespace，EventHub .. etc） 都是強制性的，不論順序為何。

--blob-container

Blob 容器名稱。

--capture-interval

可讓您設定擷取至 Azure Blob 的頻率，值應介於 60 到 900 秒之間。

--capture-size-limit

定義擷取作業之前，事件中樞內建的數據量，值應該介於10485760到524288000個字節之間。

--cleanup-policy

列舉清除原則的可能值。

接受的值: Compact, Delete, DeleteOrCompact

--destination-name

擷取目的地的名稱應該是 EventHubArchive.AzureBlockBlob。

--enable-capture

布爾值，指出是否啟用擷取。

接受的值: false, true

--mi-system-assigned

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

接受的值: false, true

預設值: False

--mi-user-assigned

使用者指派的身分識別標識碼清單。

--min-compaction-lag-in-mins --min-lag

訊息在記錄檔中保持無法壓縮的最小時間。 當 cleanupPolicy 為 Compact 或 DeleteOrCompact 時，會使用此值。

--partition-count

為事件中樞建立的數據分割數目。 根據預設，允許的值是 2-32。 已啟用 Kafka 的命名空間支援較低的值 1。 存在自定義配額時，上限會符合配額的上限。

--retention-time --retention-time-in-hours

保留此事件中樞事件的時數。 只有在 cleanupPolicy 為 Delete 時，才會使用此值。 如果 cleanupPolicy 是 Compaction，則此屬性的傳回值為 Long.MaxValue。

--skip-empty-archives

布爾值，指出是否要略過空白。

接受的值: false, true

--status

Eventhub 的狀態。

接受的值: Active, Disabled, SendDisabled

--storage-account

名稱（如果位於相同資源群組中，而不是傳統記憶體類型）或儲存體帳戶的 ARM 識別碼，以用來建立 Blob。

--timestamp-type

表示訊息將保留的時間戳類型。

接受的值: Create, LogAppend

--tombstone-retention-time-in-hours --tombstone-time

保留壓縮事件中樞之墓碑標記的時數。 只有在 cleanupPolicy 為 Compaction 時，才會使用此值。 如果取用者從起始位移開始，以確保取用者在壓縮事件中樞內之墓碑標記描述的特定索引鍵，取用者必須完成讀取此指定時間範圍內的墓碑標記。

--user-metadata

取得和設定使用者的元數據。

全域參數

--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 eventhubs eventhub delete

從指定的命名空間和資源群組中刪除事件中樞。

az eventhubs eventhub delete [--event-hub-name]
                             [--ids]
                             [--namespace-name]
                             [--resource-group]
                             [--subscription]

選擇性參數

--event-hub-name --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 eventhubs eventhub list

列出命名空間中的所有事件中樞。

az eventhubs eventhub list --namespace-name
                           --resource-group
                           [--max-items]
                           [--next-token]
                           [--skip]
                           [--top]

必要參數

--namespace-name

命名空間名稱。

--resource-group -g

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

選擇性參數

--max-items

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

--next-token

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

--skip

只有在先前的作業傳回部分結果時，才會使用Skip。 如果先前的回應包含 nextLink 元素，則 nextLink 元素的值會包含 skip 參數，指定要用於後續呼叫的起點。

--top

可用來將結果數目限制為最新的 N usageDetails。

全域參數

--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 eventhubs eventhub show

取得指定事件中樞的事件中樞描述。

az eventhubs eventhub show [--event-hub-name]
                           [--ids]
                           [--namespace-name]
                           [--resource-group]
                           [--subscription]

選擇性參數

--event-hub-name --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 eventhubs eventhub update

將新的事件中樞更新為命名空間內的巢狀資源。

az eventhubs eventhub update [--add]
                             [--archive-name-format]
                             [--blob-container]
                             [--capture-interval]
                             [--capture-size-limit]
                             [--cleanup-policy {Compact, Delete, DeleteOrCompact}]
                             [--destination-name]
                             [--enable-capture {0, 1, f, false, n, no, t, true, y, yes}]
                             [--encoding {Avro, AvroDeflate}]
                             [--event-hub-name]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--identity]
                             [--ids]
                             [--min-compaction-lag-in-mins]
                             [--namespace-name]
                             [--partition-count]
                             [--remove]
                             [--resource-group]
                             [--retention-time]
                             [--set]
                             [--skip-empty-archives {0, 1, f, false, n, no, t, true, y, yes}]
                             [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                             [--storage-account]
                             [--subscription]
                             [--timestamp-type {Create, LogAppend}]
                             [--tombstone-retention-time-in-hours]
                             [--user-metadata]

選擇性參數

--add

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

--archive-name-format

封存的 Blob 命名慣例，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 在這裡，所有參數 （Namespace，EventHub .. etc） 都是強制性的，不論順序為何。

--blob-container

Blob 容器名稱。

--capture-interval

時間範圍可讓您設定擷取至 Azure Blob 的頻率，值應介於 60 到 900 秒之間。

--capture-size-limit

大小視窗會定義擷取作業之前，事件中樞內建的數據量，值應該介於10485760到524288000個字節之間。

--cleanup-policy

列舉清除原則的可能值。

接受的值: Compact, Delete, DeleteOrCompact

--destination-name

擷取目的地的名稱。

--enable-capture

值，指出是否啟用擷取描述。

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

--encoding

列舉擷取描述編碼格式的可能值。 注意：新 API 版本中將會淘汰 『AvroDeflate』。

接受的值: Avro, AvroDeflate

--event-hub-name --name -n

事件中樞名稱。

--force-string

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

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

--identity

值，指出是否啟用擷取描述。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--ids

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

--min-compaction-lag-in-mins --min-lag

訊息在記錄檔中保持無法壓縮的最小時間。 當 cleanupPolicy 為 Compact 或 DeleteOrCompact 時，會使用此值。

--namespace-name

命名空間名稱。

--partition-count

為事件中樞建立的數據分割數目，允許的值是從 1 到 32 個數據分割。

--remove

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

--resource-group -g

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

--retention-time --retention-time-in-hours

保留此事件中樞事件的時數。 只有在 cleanupPolicy 為 Delete 時，才會使用此值。 如果 cleanupPolicy 是 Compaction，則此屬性的傳回值為 Long.MaxValue。

--set

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

--skip-empty-archives

值，指出是否要略過空白封存。

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

--status

列舉事件中樞狀態的可能值。

接受的值: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown

--storage-account

要用來建立 Blob 的記憶體帳戶資源識別碼。

--subscription

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

--timestamp-type

表示訊息將保留的時間戳類型。兩種類型的時間戳類型 - “AppendTime” 和 “CreateTime”。 AppendTime 是指訊息在訊息代理程式記錄檔內附加的時間。 CreateTime 是指在來源端產生訊息的時間，而產生者可以在傳送訊息時設定此時間戳。 預設值為 AppendTime。 如果您使用AMQP通訊協定，CreateTime等於AppendTime，其行為會維持不變。

接受的值: Create, LogAppend

--tombstone-retention-time-in-hours -t

保留壓縮事件中樞之墓碑標記的時數。 只有在 cleanupPolicy 為 Compaction 時，才會使用此值。 如果取用者從起始位移開始，以確保取用者在壓縮事件中樞內之墓碑標記描述的特定索引鍵，取用者必須完成讀取此指定時間範圍內的墓碑標記。

--user-metadata

取得和設定使用者的元數據。

全域參數

--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。