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

az eventhubs namespace

Eventhub 命名空间。

命令

名称	说明	类型	状态
az eventhubs namespace application-group	管理高级事件中心命名空间的应用程序组。	核心	GA
az eventhubs namespace application-group create	为 EventHub 命名空间创建应用程序组。	核心	GA
az eventhubs namespace application-group delete	删除命名空间的 ApplicationGroup。	核心	GA
az eventhubs namespace application-group list	列出命名空间的应用程序组列表。	核心	GA
az eventhubs namespace application-group policy	追加或删除应用程序组策略。	核心	GA
az eventhubs namespace application-group policy add	将应用程序组策略追加到现有策略。 此 cmdlet 可用于追加一个或多个限制策略。	核心	GA
az eventhubs namespace application-group policy remove	从现有策略中删除应用程序组策略。 此 cmdlet 可用于删除一个或多个限制策略。	核心	GA
az eventhubs namespace application-group show	获取命名空间的 ApplicationGroup。	核心	GA
az eventhubs namespace application-group update	更新命名空间的 ApplicationGroup。	核心	GA
az eventhubs namespace authorization-rule	Eventhub 命名空间授权规则。	核心	GA
az eventhubs namespace authorization-rule create	为命名空间创建 AuthorizationRule。	核心	GA
az eventhubs namespace authorization-rule delete	删除命名空间的 AuthorizationRule。	核心	GA
az eventhubs namespace authorization-rule keys	授权规则密钥。	核心	GA
az eventhubs namespace authorization-rule keys list	获取命名空间的主连接字符串和辅助连接字符串。	核心	GA
az eventhubs namespace authorization-rule keys renew	重新生成指定命名空间的主或辅助连接字符串。	核心	GA
az eventhubs namespace authorization-rule list	列出命名空间的授权规则列表。	核心	GA
az eventhubs namespace authorization-rule show	按规则名称获取命名空间的 AuthorizationRule。	核心	GA
az eventhubs namespace authorization-rule update	更新命名空间的 AuthorizationRule。	核心	GA
az eventhubs namespace create	创建 EventHubs 命名空间。	核心	GA
az eventhubs namespace delete	删除现有命名空间。 此操作还会删除命名空间下的所有关联资源。	核心	GA
az eventhubs namespace encryption	管理 eventhubs 命名空间加密属性。	核心	GA
az eventhubs namespace encryption add	将加密属性添加到命名空间。	核心	GA
az eventhubs namespace encryption remove	从命名空间中删除一个或多个加密属性。	核心	GA
az eventhubs namespace exists	检查提供命名空间名称的可用性。	核心	GA
az eventhubs namespace identity	管理 eventhubs 命名空间标识。	核心	GA
az eventhubs namespace identity assign	将系统或用户或系统、用户分配的标识分配给命名空间。	核心	GA
az eventhubs namespace identity remove	从命名空间中删除系统或用户或系统、用户分配的标识。	核心	GA
az eventhubs namespace list	列出订阅中的所有可用命名空间，而不考虑资源组。	核心	GA
az eventhubs namespace network-rule-set	管理命名空间的 Azure EventHubs networkruleset。	核心	GA
az eventhubs namespace network-rule-set create	为命名空间创建 NetworkRuleSet。	核心	GA
az eventhubs namespace network-rule-set ip-rule	在 networkruleSet 中为命名空间管理 Azure eventhubs ip-rules。	核心	GA
az eventhubs namespace network-rule-set ip-rule add	为命名空间的网络规则添加 IP 规则。	核心	GA
az eventhubs namespace network-rule-set ip-rule remove	从命名空间的网络规则中删除 Ip-Rule。	核心	GA
az eventhubs namespace network-rule-set list	列出命名空间的 NetworkRuleSet。	核心	GA
az eventhubs namespace network-rule-set show	获取命名空间的 NetworkRuleSet。	核心	GA
az eventhubs namespace network-rule-set update	更新命名空间的 NetworkRuleSet。	核心	GA
az eventhubs namespace network-rule-set virtual-network-rule	在 networkruleSet 中管理命名空间的 Azure eventhubs 子网规则。	核心	GA
az eventhubs namespace network-rule-set virtual-network-rule add	为命名空间的网络规则添加虚拟网络规则。	核心	GA
az eventhubs namespace network-rule-set virtual-network-rule remove	删除命名空间的网络规则。	核心	GA
az eventhubs namespace private-endpoint-connection	管理事件中心命名空间专用终结点连接。	核心	GA
az eventhubs namespace private-endpoint-connection approve	批准事件中心名称的专用终结点连接请求。	核心	GA
az eventhubs namespace private-endpoint-connection create	创建服务命名空间的 PrivateEndpoint连接ions。	核心	GA
az eventhubs namespace private-endpoint-connection delete	删除事件中心命名空间的专用终结点连接请求。	核心	GA
az eventhubs namespace private-endpoint-connection list	列出命名空间中的可用 PrivateEndpoint连接ions。	核心	GA
az eventhubs namespace private-endpoint-connection reject	拒绝事件中心命名空间的专用终结点连接请求。	核心	GA
az eventhubs namespace private-endpoint-connection show	获取指定专用终结点连接名称的说明。	核心	GA
az eventhubs namespace private-endpoint-connection update	更新服务命名空间的 PrivateEndpoint连接ions。	核心	GA
az eventhubs namespace private-endpoint-connection wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az eventhubs namespace private-link-resource	管理 eventhubs 命名空间专用链接资源。	核心	GA
az eventhubs namespace private-link-resource show	列出支持 Privatelink 的资源列表。	核心	GA
az eventhubs namespace schema-registry	管理 eventhubs 命名空间架构注册表。	核心	GA
az eventhubs namespace schema-registry create	创建 EventHub 架构组。	核心	GA
az eventhubs namespace schema-registry delete	删除 EventHub 架构组。	核心	GA
az eventhubs namespace schema-registry list	列出命名空间中的所有架构组。	核心	GA
az eventhubs namespace schema-registry show	获取 EventHub 架构组的详细信息。	核心	GA
az eventhubs namespace schema-registry update	更新 EventHub 架构组。	核心	GA
az eventhubs namespace show	获取指定命名空间的说明。	核心	GA
az eventhubs namespace update	更新命名空间。 创建后，此命名空间的资源清单是不可变的。 此操作是幂等的。	核心	GA
az eventhubs namespace wait	将 CLI 置于等待状态，直到满足条件。	核心	GA

az eventhubs namespace create

创建 EventHubs 命名空间。

az eventhubs namespace create --name
                              --resource-group
                              [--alternate-name]
                              [--capacity]
                              [--cluster-arm-id]
                              [--disable-local-auth {false, true}]
                              [--enable-auto-inflate {false, true}]
                              [--enable-kafka {false, true}]
                              [--encryption-config]
                              [--infra-encryption {false, true}]
                              [--location]
                              [--maximum-throughput-units]
                              [--mi-system-assigned {false, true}]
                              [--mi-user-assigned]
                              [--min-tls {1.0, 1.1, 1.2}]
                              [--public-network {Disabled, Enabled}]
                              [--sku {Basic, Premium, Standard}]
                              [--tags]
                              [--zone-redundant {false, true}]

示例

创建新的命名空间。

az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2 --sku Standard --enable-auto-inflate --maximum-throughput-units 20

创建启用了标识和加密的新命名空间。

az eventhubs namespace create --resource-group myresourcegroup --name mynamespace --location westus --sku Premium --mi-user-assigned /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName

必需参数

--name -n

命名空间的名称。

--resource-group -g

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

可选参数

--alternate-name

别名和命名空间名称相同时指定的备用名称。

--capacity

Sku 的容量。

--cluster-arm-id

命名空间的群集 ARM ID。

--disable-local-auth

一个布尔值，该值指示是否为事件中心启用/禁用 SAS 身份验证。

接受的值: false, true

--enable-auto-inflate

一个布尔值，该值指示是否为 eventhub 命名空间启用 AutoInflate。

接受的值: false, true

--enable-kafka

一个布尔值，该值指示是否为 eventhub 命名空间启用 Kafka。

接受的值: false, true

--encryption-config

KeyVaultProperties 对象的列表。

--infra-encryption

一个布尔值，该值指示是否启用/禁用基础结构加密（双重加密）。

接受的值: false, true

--location -l

位置。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--maximum-throughput-units

启用 AutoInflate 时吞吐量单位的上限，vaule 应位于 0 到 20 个吞吐量单位内。 （如果 AutoInflateEnabled = true），则为 0。

--mi-system-assigned

启用系统分配的标识。

接受的值: false, true

默认值: False

--mi-user-assigned

用户分配的标识 ID 列表。

--min-tls --minimum-tls-version

群集支持的最低 TLS 版本，例如 1.2。

接受的值: 1.0, 1.1, 1.2

--public-network --public-network-access

这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 如果值为 SecuredByPerimeter，则入站和出站通信由网络安全外围和配置文件的访问规则控制。

接受的值: Disabled, Enabled

--sku

命名空间 SKU。

接受的值: Basic, Premium, Standard

默认值: Standard

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--zone-redundant

启用此属性会在支持的可用性区域中创建标准 EventHubs 命名空间。

接受的值: false, true

全局参数

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

删除现有命名空间。 此操作还会删除命名空间下的所有关联资源。

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

示例

删除命名空间

az eventhubs namespace delete --resource-group myresourcegroup --name mynamespace

可选参数

--ids

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

--name --namespace-name -n

命名空间名称。

--no-wait

不等待长时间运行的操作完成。

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

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

检查提供命名空间名称的可用性。

az eventhubs namespace exists --name

必需参数

--name

要检查命名空间名称可用性的名称。

全局参数

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

列出订阅中的所有可用命名空间，而不考虑资源组。

az eventhubs namespace list [--max-items]
                            [--next-token]
                            [--resource-group]

示例

按资源组列出事件中心命名空间。

az eventhubs namespace list --resource-group myresourcegroup

按订阅获取命名空间。

az eventhubs namespace list

可选参数

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

--resource-group -g

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

全局参数

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

获取指定命名空间的说明。

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

示例

显示命名空间详细信息。

az eventhubs namespace show --resource-group myresourcegroup --name mynamespace

可选参数

--ids

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

--name --namespace-name -n

命名空间名称。

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

更新命名空间。 创建后，此命名空间的资源清单是不可变的。 此操作是幂等的。

az eventhubs namespace update [--add]
                              [--alternate-name]
                              [--capacity]
                              [--cluster-arm-id]
                              [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                              [--enable-auto-inflate {0, 1, f, false, n, no, t, true, y, yes}]
                              [--encryption]
                              [--endpoint-connections]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--identity]
                              [--ids]
                              [--kafka-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                              [--maximum-throughput-units]
                              [--minimum-tls-version {1.0, 1.1, 1.2}]
                              [--name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--sku {Basic, Premium, Standard}]
                              [--subscription]
                              [--tags]
                              [--tier {Basic, Premium, Standard}]
                              [--zone-redundant {0, 1, f, false, n, no, t, true, y, yes}]

示例

更新新命名空间。

az eventhubs namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value --enable-auto-inflate True

可选参数

--add

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

--alternate-name

别名和命名空间名称相同时指定的备用名称。

--capacity

基本层或标准层的事件中心吞吐量单位，其中值应为 0 到 20 个吞吐量单位。 高级版层的事件中心高级单位，其中值应为 0 到 10 个高级单位。

--cluster-arm-id

命名空间的群集 ARM ID。

--disable-local-auth

此属性禁用事件中心命名空间的 SAS 身份验证。

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

--enable-auto-inflate

指示是否为 eventhub 命名空间启用 AutoInflate 的值。

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

--encryption

BYOK 加密说明的属性支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--endpoint-connections --private-endpoint-connections

专用终结点连接列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

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

--identity

BYOK 标识说明的属性支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--ids

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

--kafka-enabled

指示是否为 eventhub 命名空间启用 Kafka 的值。

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

--maximum-throughput-units

启用 AutoInflate 时吞吐量单位的上限，值应在 0 到 20 个吞吐量单位内。 （如果 AutoInflateEnabled = true），则为“0”。

--minimum-tls-version

要支持的群集的最低 TLS 版本，例如“1.2”。

接受的值: 1.0, 1.1, 1.2

--name --namespace-name -n

命名空间名称。

--no-wait

不等待长时间运行的操作完成。

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

--public-network-access

这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。

接受的值: Disabled, Enabled, SecuredByPerimeter

--remove

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

--resource-group -g

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

--set

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

--sku

此 SKU 的名称。

接受的值: Basic, Premium, Standard

--subscription

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

--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--tier

此特定 SKU 的计费层。

接受的值: Basic, Premium, Standard

--zone-redundant

启用此属性会在支持的可用性区域中创建标准事件中心命名空间。

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

全局参数

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

将 CLI 置于等待状态，直到满足条件。

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

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name --namespace-name -n

命名空间名称。

--resource-group -g

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

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--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 获取完整的调试日志。