你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az eventgrid topic
注意
此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。
管理Azure 事件网格主题。
命令
az eventgrid topic create
创建主题。
az eventgrid topic create --name
--resource-group
[--extended-location-name]
[--extended-location-type {customlocation}]
[--identity {noidentity, systemassigned}]
[--inbound-ip-rules]
[--input-mapping-default-values]
[--input-mapping-fields]
[--input-schema {cloudeventschemav1_0, customeventschema, eventgridschema}]
[--kind {azure, azurearc}]
[--location]
[--mi-system-assigned]
[--mi-user-assigned]
[--public-network-access {disabled, enabled}]
[--sku {basic, premium}]
[--tags]
示例
创建新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2
使用自定义输入映射创建新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema customeventschema --input-mapping-fields topic=myTopicField eventType=myEventTypeField --input-mapping-default-values subject=DefaultSubject dataVersion=1.0
创建接受 CloudEvents V1.0 架构中发布的事件的新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema cloudeventschemav1_0
创建允许使用基本 SKU 和系统分配标识的特定入站 IP 规则的新主题
az eventgrid topic create -g rg1 --name topic1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku Basic --identity systemassigned
在 Azure 中创建新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2
在 Azure 中创建新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2 --kind azure
在面向自定义位置的 AzureArc 中创建新主题。
az eventgrid topic create -g rg1 --name topic1 -l eastus2euap --kind azurearc --extended-location-name /subscriptions/<subid>/resourcegroups/<rgname>/providers/microsoft.extendedlocation/customlocations/<cust-loc-name> --extended-location-type customlocation --input-schema CloudEventSchemaV1_0
必需参数
主题名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
如果 kind==azurearc,则为扩展位置名称。
如果 kind==azurearc,则为扩展位置类型。
参数“identity”已弃用,将在将来的版本中删除。
资源的托管标识类型。 将来将被弃用并替换为 --mi-system-assigned-identity。
入站 IP 规则列表。
在 CIDR 表示法中指定 IP 地址的入站 IP 规则列表,例如 10.0.0.0.0/8 以及根据 IpMask 的匹配项或不匹配执行的相应操作。 可能的值包括 - 允许。
将输入架构指定为 customeventschema 时,此参数可用于根据默认值指定输入映射。 自定义架构不包含与此参数支持的三个字段之一对应的字段时,可以使用此参数。 以“key=value”格式指定空格分隔的映射。 允许的键名称为“subject”、“eventtype”、“dataversion”。 相应的值名称应指定用于映射的默认值,并且仅在已发布事件没有特定字段的有效映射时使用它们。
将输入架构指定为 customeventschema 时,此参数用于根据字段名称指定输入映射。 以“key=value”格式指定空格分隔的映射。 允许的键名称为“id”、“topic”、“eventtime”、“subject”、“eventtype”、“dataversion”。 相应的值名称应指定自定义输入架构中字段的名称。 如果未提供“id”或“eventtime”的映射,事件网格将自动生成这两个字段的默认值。
将传入事件发布到本主题/域的架构。 如果将 customeventschema 指定为此参数的值,则还必须为至少一个 --input_mapping_default_values/ --input_mapping_fields 提供值。
主题资源的类型。
位置。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
存在此参数表示将使用 SystemAssigned 托管标识。
在 identityType 为用户或混合时添加用户分配的标识。 此属性适用于所有目标类型,存储Queue 除外。 可以使用多个 --mi-user-assigned
参数来指定多个属性。
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制到特定 IP。
资源的 SKU 名称。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic create (eventgrid 扩展)
命令组“az eventgrid”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
创建主题。
az eventgrid topic create --location
--name
--resource-group
[--identity {noidentity, systemassigned}]
[--inbound-ip-rules]
[--input-mapping-default-values]
[--input-mapping-fields]
[--input-schema {cloudeventschemav1_0, customeventschema, eventgridschema}]
[--public-network-access {disabled, enabled}]
[--sku {basic, premium}]
[--tags]
示例
创建新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2
使用自定义输入映射创建新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema customeventschema --input-mapping-fields topic=myTopicField eventType=myEventTypeField --input-mapping-default-values subject=DefaultSubject dataVersion=1.0
创建接受 CloudEvents V1.0 架构中发布的事件的新主题。
az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema cloudeventschemav1_0
创建允许使用基本 SKU 和系统分配标识的特定入站 IP 规则的新主题
az eventgrid topic create -g rg1 --name topic1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku Basic --identity systemassigned
必需参数
位置。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
主题名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
资源的标识类型(例如主题或域)。
入站 IP 规则列表。
在 CIDR 表示法中指定 IP 地址的入站 IP 规则列表,例如 10.0.0.0.0/8 以及根据 IpMask 的匹配项或不匹配执行的相应操作。 可能的值包括 - 允许。
将输入架构指定为 customeventschema 时,此参数可用于根据默认值指定输入映射。 自定义架构不包含与此参数支持的三个字段之一对应的字段时,可以使用此参数。 以“key=value”格式指定空格分隔的映射。 允许的键名称为“subject”、“eventtype”、“dataversion”。 相应的值名称应指定用于映射的默认值,并且仅在已发布事件没有特定字段的有效映射时使用它们。
将输入架构指定为 customeventschema 时,此参数用于根据字段名称指定输入映射。 以“key=value”格式指定空格分隔的映射。 允许的键名称为“id”、“topic”、“eventtime”、“subject”、“eventtype”、“dataversion”。 相应的值名称应指定自定义输入架构中字段的名称。 如果未提供“id”或“eventtime”的映射,事件网格将自动生成这两个字段的默认值。
将传入事件发布到本主题/域的架构。 如果将 customeventschema 指定为此参数的值,则还必须为至少一个 --input_mapping_default_values/ --input_mapping_fields 提供值。
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制到特定 IP。
资源的 SKU 名称。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic delete
删除主题。
az eventgrid topic delete [--ids]
[--name]
[--resource-group]
[--subscription]
示例
删除主题。
az eventgrid topic delete -g rg1 --name topic1
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
主题名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic delete (eventgrid 扩展)
命令组“az eventgrid”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
删除主题。
az eventgrid topic delete [--ids]
[--name]
[--resource-group]
[--subscription]
示例
删除主题。
az eventgrid topic delete -g rg1 --name topic1
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
主题名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic list
列出可用主题。
az eventgrid topic list [--odata-query]
[--resource-group]
示例
列出当前 Azure 订阅中的所有主题。
az eventgrid topic list
列出资源组中的所有主题。
az eventgrid topic list -g rg1
列出资源组中名称包含模式“XYZ”的所有主题
az eventgrid topic list -g rg1 --odata-query "Contains(name, 'XYZ')"
列出资源组中的所有主题,名称为“name1”的域名除外
az eventgrid topic list -g rg1 --odata-query "NOT (name eq 'name1')"
可选参数
用于筛选列表结果的 OData 查询。 目前仅允许对 Name 属性进行筛选。 支持的操作包括:CONTAINS、eq(等于)、ne(不等于)、AND、OR 和 NOT。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic list (eventgrid 扩展)
命令组“az eventgrid”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
列出可用主题。
az eventgrid topic list [--odata-query]
[--resource-group]
示例
列出当前 Azure 订阅中的所有主题。
az eventgrid topic list
列出资源组中的所有主题。
az eventgrid topic list -g rg1
列出资源组中名称包含模式“XYZ”的所有主题
az eventgrid topic list -g rg1 --odata-query "Contains(name, 'XYZ')"
列出资源组中的所有主题,名称为“name1”的域名除外
az eventgrid topic list -g rg1 --odata-query "NOT (name eq 'name1')"
可选参数
用于使用 OData 语法筛选结果的查询。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic show
获取主题的详细信息。
az eventgrid topic show [--ids]
[--name]
[--resource-group]
[--subscription]
示例
显示主题的详细信息。
az eventgrid topic show -g rg1 -n topic1
根据资源 ID 显示主题的详细信息。
az eventgrid topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
主题名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic show (eventgrid 扩展)
命令组“az eventgrid”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
获取主题的详细信息。
az eventgrid topic show [--ids]
[--name]
[--resource-group]
[--subscription]
示例
显示主题的详细信息。
az eventgrid topic show -g rg1 -n topic1
根据资源 ID 显示主题的详细信息。
az eventgrid topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
主题名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic update
更新主题。
az eventgrid topic update [--identity {noidentity, systemassigned}]
[--ids]
[--inbound-ip-rules]
[--mi-system-assigned]
[--mi-user-assigned]
[--name]
[--public-network-access {disabled, enabled}]
[--resource-group]
[--sku {basic, premium}]
[--subscription]
[--tags]
示例
使用新的 SKU、标识和公共网络访问信息更新现有主题的属性。
az eventgrid topic update -g rg1 --name topic1 --sku Premium --identity systemassigned --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic
可选参数
参数“identity”已弃用,将在将来的版本中删除。
资源的托管标识类型。 将来将被弃用并替换为 --mi-system-assigned-identity。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
在 CIDR 表示法中指定 IP 地址的入站 IP 规则列表,例如 10.0.0.0.0/8 以及根据 IpMask 的匹配项或不匹配执行的相应操作。 可能的值包括 - 允许。
存在此参数表示将使用 SystemAssigned 托管标识。
在 identityType 为用户或混合时添加用户分配的标识。 此属性适用于所有目标类型,存储Queue 除外。 可以使用多个 --mi-user-assigned
参数来指定多个属性。
主题名称。
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制到特定 IP。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
资源的 SKU 名称。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az eventgrid topic update (eventgrid 扩展)
命令组“az eventgrid”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
更新主题。
az eventgrid topic update [--identity {noidentity, systemassigned}]
[--ids]
[--inbound-ip-rules]
[--name]
[--public-network-access {disabled, enabled}]
[--resource-group]
[--sku {basic, premium}]
[--subscription]
[--tags]
示例
使用新的 SKU、标识和公共网络访问信息更新现有主题的属性。
az eventgrid topic update -g rg1 --name topic1 --sku Premium --identity systemassigned --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic
可选参数
资源的标识类型(例如主题或域)。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
在 CIDR 表示法中指定 IP 地址的入站 IP 规则列表,例如 10.0.0.0.0/8 以及根据 IpMask 的匹配项或不匹配执行的相应操作。 可能的值包括 - 允许。
主题名称。
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制到特定 IP。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
资源的 SKU 名称。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。