你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az eventhubs eventhub

参考

管理 Azure EventHubs eventhub 和授权规则。

命令

名称	说明	类型	Status
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}]
                             [--destination-name]
                             [--enable-capture {false, true}]
                             [--mi-system-assigned {false, true}]
                             [--mi-user-assigned]
                             [--partition-count]
                             [--retention-time]
                             [--skip-empty-archives {false, true}]
                             [--status {Active, Disabled, SendDisabled}]
                             [--storage-account]
                             [--tombstone-retention-time-in-hours]

示例

创建新的 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

--destination-name

捕获目标的名称应为 EventHubArchive.AzureBlockBlob。

--enable-capture

一个布尔值，该值指示是否启用捕获。

接受的值: false, true

--mi-system-assigned

启用系统分配的标识。

接受的值: false, true

默认值: False

--mi-user-assigned

用户分配的标识 ID 列表。

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

名称（如果位于同一资源组中而不是经典存储类型）或用于创建 Blob 的存储帐户的 ARM ID。

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

保留压缩事件中心的逻辑删除标记的小时数。仅当 cleanupPolicy 为 Compaction 时，才使用此值。使用者必须在此指定的时间范围内完成读取逻辑标记（如果使用者从开始偏移量开始）以确保它们为压缩事件中心内逻辑标记描述的特定键获得有效的快照。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 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

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 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

订阅的名称或 ID。可以使用 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}]
                             [--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]
                             [--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]
                             [--tombstone-retention-time-in-hours]

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--archive-name-format

--blob-container

Blob 容器名称。

--capture-interval

使用时间范围可以设置捕获到 Azure Blob 的频率，值应介于 60 到 900 秒之间。

--capture-size-limit

大小窗口定义在捕获操作之前在事件中心生成的数据量，值应介于10485760到524288000字节之间。

--cleanup-policy

枚举清理策略的可能值。

接受的值: Compact, Delete

--destination-name

捕获目标的名称。

--enable-capture

一个值，该值指示是否启用捕获说明。

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

--encoding

枚举捕获说明的编码格式的可能值。注意：“AvroDeflate”将在新的 API 版本中弃用。

接受的值: 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

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--namespace-name

命名空间名称。

--partition-count

为事件中心创建的分区数，允许的值从 1 到 32 个分区。

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

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

保留此事件中心的事件的小时数。仅当 cleanupPolicy 为 Delete 时，才使用此值。如果 cleanupPolicy 为 Compact，则此属性的返回值为 Long.MaxValue。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--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 的存储帐户的资源 ID。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

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

保留压缩事件中心的逻辑删除标记的小时数。仅当 cleanupPolicy 为 Compact 时，才使用此值。使用者必须在此指定的时间范围内完成读取逻辑标记（如果使用者从开始偏移量开始）以确保它们为压缩事件中心内逻辑标记描述的特定键获得有效的快照。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az eventhubs eventhub

命令

az eventhubs eventhub create

示例

必需参数

可选参数

az eventhubs eventhub delete

可选参数

az eventhubs eventhub list

必需参数

可选参数

az eventhubs eventhub show

可选参数

az eventhubs eventhub update

可选参数

其他资源