az eventhubs namespace
Eventhub 命名空间。
命令
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]
[--geo-data-replication-config --replica-config]
[--infra-encryption {false, true}]
[--location]
[--max-lag --max-replication-lag-duration-in-seconds]
[--maximum-throughput-units]
[--mi-system-assigned {false, true}]
[--mi-user-assigned]
[--min-tls --minimum-tls-version {1.0, 1.1, 1.2}]
[--public-network --public-network-access {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
必需参数
命名空间的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
别名和命名空间名称相同时指定的备用名称。
Sku 的容量。
Namespace的群集 ARM ID。
一个布尔值,该值指示是否为事件中心启用/禁用 SAS 身份验证。
| 属性 | 值 |
|---|---|
| 接受的值: | false, true |
一个布尔值,该值指示是否为 eventhub 命名空间启用 AutoInflate。
| 属性 | 值 |
|---|---|
| 接受的值: | false, true |
一个布尔值,该值指示是否为 eventhub 命名空间启用 Kafka。
| 属性 | 值 |
|---|---|
| 接受的值: | false, true |
KeyVaultProperties 对象的列表。
保留命名空间副本的区域列表。
一个布尔值,该值指示是否启用/禁用基础结构加密(双重加密)。
| 属性 | 值 |
|---|---|
| 接受的值: | false, true |
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
从主副本到次要副本仲裁的数据复制操作的最大可接受延迟。
启用 AutoInflate 时吞吐量单位的上限,vaule 应位于 0 到 20 个吞吐量单位内。 (如果 AutoInflateEnabled = true),则为 0。
启用系统分配的标识。
| 属性 | 值 |
|---|---|
| Parameter group: | Managed Identity Arguments |
| 默认值: | False |
| 接受的值: | false, true |
用户分配的标识 ID 列表。
| 属性 | 值 |
|---|---|
| Parameter group: | Managed Identity Arguments |
群集支持的最低 TLS 版本,例如 1.2。
| 属性 | 值 |
|---|---|
| 接受的值: | 1.0, 1.1, 1.2 |
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 如果值为 SecuredByPerimeter,则入站和出站通信由网络安全外围和配置文件的访问规则控制。
| 属性 | 值 |
|---|---|
| 接受的值: | Disabled, Enabled |
命名空间 SKU。
| 属性 | 值 |
|---|---|
| 默认值: | Standard |
| 接受的值: | Basic, Premium, Standard |
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
启用此属性会在支持的可用性区域中创建标准 EventHubs 命名空间。
| 属性 | 值 |
|---|---|
| 接受的值: | false, true |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az eventhubs namespace delete
删除现有命名空间。 此作还会删除命名空间下的所有关联资源。
az eventhubs namespace delete [--ids]
[--name --namespace-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
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
命名空间名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az eventhubs namespace exists
检查提供命名空间名称的可用性。
az eventhubs namespace exists --name
必需参数
用于检查命名空间名称可用性的名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Parameters Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az eventhubs namespace failover
GeoDR 故障转移。
az eventhubs namespace failover [--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--primary-location]
[--resource-group]
[--subscription]
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
如果 Force 为 false,则在确保不会丢失数据后尝试正常故障转移。 如果强制标志设置为 true,则会尝试强制故障转移并可能丢失数据。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
命名空间名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
故障转移后新主位置的查询参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的 --next-token 参数中提供令牌值。
| 属性 | 值 |
|---|---|
| Parameter group: | Pagination Arguments |
用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。
| 属性 | 值 |
|---|---|
| Parameter group: | Pagination Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az eventhubs namespace show
获取指定命名空间的说明。
az eventhubs namespace show [--ids]
[--name --namespace-name]
[--resource-group]
[--subscription]
示例
显示命名空间详细信息。
az eventhubs namespace show --resource-group myresourcegroup --name mynamespace
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
命名空间名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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 --private-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}]
[--locations]
[--max-lag --max-replication-lag-duration-in-seconds]
[--maximum-throughput-units]
[--minimum-tls-version {1.0, 1.1, 1.2}]
[--name --namespace-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
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>。
| 属性 | 值 |
|---|---|
| Parameter group: | Generic Update Arguments |
别名和命名空间名称相同时指定的备用名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
基本层或标准层的事件中心吞吐量单位,其中值应为 0 到 20 个吞吐量单位。 高级层的事件中心高级单位,其中值应为 0 到 10 个高级单位。
| 属性 | 值 |
|---|---|
| Parameter group: | Sku Arguments |
Namespace的群集 ARM ID。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
此属性禁用事件中心命名空间的 SAS 身份验证。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
指示是否为 eventhub 命名空间启用 AutoInflate 的值。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
BYOK 加密说明的属性支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
专用终结点连接列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
| 属性 | 值 |
|---|---|
| Parameter group: | Generic Update Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
BYOK 标识说明的属性支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| Parameter group: | Parameters Arguments |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
指示是否为 eventhub 命名空间启用 Kafka 的值。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
维护命名空间副本的区域列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| Parameter group: | GeoDataReplication Arguments |
从主副本到次要副本仲裁的数据复制操作的最大可接受延迟。 当滞后时间超过配置的量时,主副本上的操作将失败。
| 属性 | 值 |
|---|---|
| Parameter group: | GeoDataReplication Arguments |
启用 AutoInflate 时吞吐量单位的上限,值应在 0 到 20 个吞吐量单位内。 (如果 AutoInflateEnabled = true),则为“0”。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
要支持的群集的最低 TLS 版本,例如“1.2”。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
| 接受的值: | 1.0, 1.1, 1.2 |
命名空间名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
| 接受的值: | Disabled, Enabled, SecuredByPerimeter |
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| 属性 | 值 |
|---|---|
| Parameter group: | Generic Update Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>。
| 属性 | 值 |
|---|---|
| Parameter group: | Generic Update Arguments |
此 SKU 的名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Sku Arguments |
| 接受的值: | Basic, Premium, Standard |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
| 属性 | 值 |
|---|---|
| Parameter group: | Parameters Arguments |
此特定 SKU 的计费层。
| 属性 | 值 |
|---|---|
| Parameter group: | Sku Arguments |
| 接受的值: | Basic, Premium, Standard |
启用此属性会在支持的可用性区域中创建标准事件中心Namespace。
| 属性 | 值 |
|---|---|
| Parameter group: | Properties Arguments |
| 接受的值: | 0, 1, f, false, n, no, t, true, y, yes |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az eventhubs namespace wait
将 CLI 置于等待状态,直到满足条件。
az eventhubs namespace wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name --namespace-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
等待在“Succeeded”中使用“provisioningState”创建。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
等到删除为止。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
等待资源存在。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
轮询间隔(以秒为单位)。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | 30 |
命名空间名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
最大等待(以秒为单位)。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | 3600 |
等到 provisioningState 更新为“Succeeded”。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |