您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az eventgrid system-topic event-subscription

管理系统主题的事件订阅。

命令

az eventgrid system-topic event-subscription create

为系统主题创建新的事件订阅。

az eventgrid system-topic event-subscription delete

删除系统主题的事件订阅。

az eventgrid system-topic event-subscription list

列出特定系统主题的事件订阅。

az eventgrid system-topic event-subscription show

获取系统主题的事件订阅的详细信息。

az eventgrid system-topic event-subscription update

更新系统主题的事件订阅。

az eventgrid system-topic event-subscription create

为系统主题创建新的事件订阅。

az eventgrid system-topic event-subscription create --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--advanced-filter]
                                                    [--azure-active-directory-application-id-or-uri]
                                                    [--azure-active-directory-tenant-id]
                                                    [--deadletter-endpoint]
                                                    [--delivery-attribute-mapping]
                                                    [--enable-advanced-filtering-on-arrays {false, true}]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--event-delivery-schema {cloudeventschemav1_0, custominputschema, eventgridschema}]
                                                    [--event-ttl]
                                                    [--expiration-date]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--max-delivery-attempts]
                                                    [--max-events-per-batch]
                                                    [--preferred-batch-size-in-kilobytes]
                                                    [--qttl]
                                                    [--subject-begins-with]
                                                    [--subject-case-sensitive {false, true}]
                                                    [--subject-ends-with]
                                                    [--subscription]

示例

使用默认筛选器为事件网格系统主题创建新的事件订阅。

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code

为事件网格系统主题创建新的事件订阅,并使用筛选器指定使用者前缀。

az eventgrid system-topic event-subscription create --name es4 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --subject-begins-with mysubject_prefix

为事件网格系统主题创建新的事件订阅,使用默认筛选器,将 CloudEvent V 1.0 用作传递架构。

az eventgrid system-topic event-subscription create -n es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --event-delivery-schema cloudeventschemav1_0

为事件网格系统主题创建新的事件订阅,其中包含死信目标和自定义重试策略,最多10次传递尝试,事件 TTL 为2小时 () 和到期日期之前发生的情况。

az eventgrid system-topic event-subscription create --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \
    --max-delivery-attempts 10 --event-ttl 120 --expiration-date "2022-10-31"

为事件网格系统主题创建新的事件订阅,并使用 Azure Active Directory 启用 Webhook 作为目标。

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --azure-active-directory-tenant-id azureactivedirectorytenantid
    --azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri

使用 Azure 函数作为目标为事件网格系统主题创建新的事件订阅。

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction

为事件网格系统主题创建新的事件订阅,并使用存储队列作为目标,ttl 为5分钟

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint-type storagequeue \
    --endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
    --storage-queue-msg-ttl 300

为事件网格系统主题创建新的事件订阅,并在数组上启用高级筛选

az eventgrid system-topic event-subscription create -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction \
    --enable-advanced-filtering-on-arrays true

必需参数

--name -n

事件订阅的名称。

--resource-group -g

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

--system-topic-name

系统主题的名称。

可选参数

--advanced-filter

使用高级筛选器,可以基于特定事件属性筛选事件。

--azure-active-directory-application-id-or-uri

用于获取访问令牌的 Azure Active Directory 应用程序 Id 或 Uri,它将作为传递请求中的持有者令牌包含在内。 仅适用于作为目标的 webhook。

--azure-active-directory-tenant-id

用于获取访问令牌的 Azure Active Directory 租户 Id,该令牌将作为传递请求中的持有者令牌包括在内。 仅适用于作为目标的 webhook。

--deadletter-endpoint

Azure 存储 blob 容器目标的 Azure 资源 ID,其中 EventGrid 应死信无法传递的事件的事件订阅。

--delivery-attribute-mapping

添加传递属性映射,以便在传递事件时通过 HTTP 标头发送额外的信息。 此属性对除 StorageQueue 以外的所有目标类型都有效。 可以使用多个参数指定多个属性 --delivery-attribute-mapping

--enable-advanced-filtering-on-arrays --enable-af-arr

允许对值数组计算高级筛选器,而不是要求使用单数值。

接受的值: false, true
--endpoint

终结点,EventGrid 应提供与此事件订阅匹配的事件。 对于 webhook 终结点类型,这应该是对应的 webhook URL。 对于其他终结点类型,此应为终结点的 Azure 资源标识符。 目标终结点应在执行任何事件网格命令之前已创建并可供使用。

--endpoint-type

目标终结点的类型。

接受的值: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
默认值: webhook
--event-delivery-schema

应在其中传递此事件订阅的事件的架构。 默认情况下,事件将根据相应主题的输入架构) (发布到它们的架构中。

接受的值: cloudeventschemav1_0, custominputschema, eventgridschema
--event-ttl

事件生存时间 (分钟) 。 必须是介于1和1440之间的数字。

默认值: 1440
--expiration-date

日期或日期时间 (UTC 格式(例如 "2018-11-30T11:59: 59 + 00: 00" 或 "2018-11-30") ) 之后事件订阅将过期。 默认情况下,事件订阅没有过期时间。

--included-event-types

事件类型的以空格分隔的列表 (例如,Microsoft。存储。BlobCreated 和 Microsoft。存储。BlobDeleted) 。 为了订阅所有默认事件类型,请不要为此参数指定任何值。 对于事件网格主题,事件类型是 "客户定义的"。 对于 Azure 事件(例如存储帐户、IoT 中心等),可以使用此 CLI 命令 "az eventgrid" (类型列表-事件类型)来查询其事件类型。

--labels

要与此事件订阅关联的标签的空格分隔列表。

--max-delivery-attempts

最大传递尝试次数。 必须是介于1和30之间的数字。

默认值: 30
--max-events-per-batch

批中的最大事件数。 必须是介于 1 和 5000 之间的数字。

--preferred-batch-size-in-kilobytes

首选批大小(kb)。 必须是介于 1 和 1024 之间的数字。

--qttl --storage-queue-msg-ttl

存储队列消息生存时间(以秒为单位)。

--subject-begins-with

一个可选字符串,用于根据前缀筛选事件订阅的事件。 不支持通配符。

--subject-case-sensitive

指定以指示是否应以区分大小写的方式比较主题字段。 如果标志存在,则为 True。

接受的值: false, true
--subject-ends-with

用于筛选基于后缀的事件订阅事件的可选字符串。 不支持通配符。

--subscription

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

az eventgrid system-topic event-subscription delete

删除系统主题的事件订阅。

az eventgrid system-topic event-subscription delete --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--subscription]
                                                    [--yes]

示例

删除事件网格系统主题的事件订阅。

az eventgrid system-topic event-subscription delete --name es1 \
    -g rg1 --system-topic-name systemtopic1 \

必需参数

--name -n

事件订阅的名称。

--resource-group -g

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

--system-topic-name

系统主题的名称。

可选参数

--subscription

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

--yes -y

不提示确认。

az eventgrid system-topic event-subscription list

列出特定系统主题的事件订阅。

az eventgrid system-topic event-subscription list --resource-group
                                                  --system-topic-name
                                                  [--odata-query]
                                                  [--query-examples]
                                                  [--subscription]

示例

列出为事件网格系统主题创建的所有事件订阅。

az eventgrid system-topic event-subscription list -g rg1 --system-topic-name systemtopic1

必需参数

--resource-group -g

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

--system-topic-name

系统主题的名称。

可选参数

--odata-query

用于筛选列表结果的 OData 查询。 目前仅允许对 Name 属性进行筛选。 支持的操作包括: CONTAINS、eq (用于相等) 、ne (不等于) 、AND、OR 和 NOT。

--query-examples

建议 JMESPath 字符串。 可以复制其中一个查询,然后将其粘贴在双引号内,以查看结果。 您可以添加一个或多个位置关键字,以便我们可以根据这些关键字提供建议。

--subscription

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

az eventgrid system-topic event-subscription show

获取系统主题的事件订阅的详细信息。

az eventgrid system-topic event-subscription show --name
                                                  --resource-group
                                                  --system-topic-name
                                                  [--include-attrib-secret {false, true}]
                                                  [--include-full-endpoint-url {false, true}]
                                                  [--query-examples]
                                                  [--subscription]

示例

显示事件网格系统主题的事件订阅的详细信息。

az eventgrid system-topic event-subscription show --name es1 \
     -g rg1 --system-topic-name systemtopic1

显示事件网格系统的事件订阅的详细信息主题包括任何静态传递属性的机密。

az eventgrid system-topic event-subscription show --name es1 \
     -g rg1 --system-topic-name systemtopic1 --include-attrib-secret

必需参数

--name -n

事件订阅的名称。

--resource-group -g

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

--system-topic-name

系统主题的名称。

可选参数

--include-attrib-secret --include-static-delivery-attribute-secret

指示是否应返回任何静态传递属性的机密。 如果标志存在,则为 True。

接受的值: false, true
--include-full-endpoint-url

指定以指示是否应返回完整的终结点 URL。 如果标志存在,则为 True。

接受的值: false, true
--query-examples

建议 JMESPath 字符串。 可以复制其中一个查询,然后将其粘贴在双引号内,以查看结果。 您可以添加一个或多个位置关键字,以便我们可以根据这些关键字提供建议。

--subscription

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

az eventgrid system-topic event-subscription update

更新系统主题的事件订阅。

az eventgrid system-topic event-subscription update --name
                                                    --resource-group
                                                    --system-topic-name
                                                    [--advanced-filter]
                                                    [--deadletter-endpoint]
                                                    [--delivery-attribute-mapping]
                                                    [--enable-advanced-filtering-on-arrays {false, true}]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--qttl]
                                                    [--subject-begins-with]
                                                    [--subject-ends-with]
                                                    [--subscription]

示例

更新事件网格系统主题的事件订阅以指定新的终结点。

az eventgrid system-topic event-subscription update --name es1 \
    -g rg1 --system-topic-name systemtopic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code

更新事件网格系统主题的事件订阅,以指定新的主题端-带有筛选器。

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .jpg

更新事件网格系统主题的事件订阅,以指定新的终结点和新的主题端-使用筛选包含的事件类型的新列表。

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .png \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --included-event-types Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted

更新 Azure 事件网格系统主题的事件订阅,以包含死信目标。

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1

使用高级筛选器更新 Azure 事件网格系统主题的事件订阅。

az eventgrid system-topic event-subscription update --name es3 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code
    --advanced-filter data.blobType StringIn BlockBlob
    --advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net

使用存储队列作为目标(ttl 为5分钟)更新事件网格系统主题的事件订阅

az eventgrid system-topic event-subscription update -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --storage-queue-msg-ttl 300

为启用了阵列的高级筛选的事件网格系统主题更新事件订阅

az eventgrid system-topic event-subscription update -n es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --enable-advanced-filtering-on-arrays true

必需参数

--name -n

事件订阅的名称。

--resource-group -g

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

--system-topic-name

系统主题的名称。

可选参数

--advanced-filter

使用高级筛选器,可以基于特定事件属性筛选事件。

--deadletter-endpoint

Azure 存储 blob 容器目标的 Azure 资源 ID,其中 EventGrid 应死信无法传递的事件的事件订阅。

--delivery-attribute-mapping

添加传递属性映射,以便在传递事件时通过 HTTP 标头发送额外的信息。 此属性对除 StorageQueue 以外的所有目标类型都有效。 可以使用多个参数指定多个属性 --delivery-attribute-mapping

--enable-advanced-filtering-on-arrays --enable-af-arr

允许对值数组计算高级筛选器,而不是要求使用单数值。

接受的值: false, true
--endpoint

终结点,EventGrid 应提供与此事件订阅匹配的事件。 对于 webhook 终结点类型,这应该是对应的 webhook URL。 对于其他终结点类型,此应为终结点的 Azure 资源标识符。 目标终结点应在执行任何事件网格命令之前已创建并可供使用。

--endpoint-type

目标终结点的类型。

接受的值: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
默认值: webhook
--included-event-types

事件类型的以空格分隔的列表 (例如,Microsoft。存储。BlobCreated 和 Microsoft。存储。BlobDeleted) 。 为了订阅所有默认事件类型,请不要为此参数指定任何值。 对于事件网格主题,事件类型是 "客户定义的"。 对于 Azure 事件(例如存储帐户、IoT 中心等),可以使用此 CLI 命令 "az eventgrid" (类型列表-事件类型)来查询其事件类型。

--labels

要与此事件订阅关联的标签的空格分隔列表。

--qttl --storage-queue-msg-ttl

存储队列消息生存时间(以秒为单位)。

--subject-begins-with

一个可选字符串,用于根据前缀筛选事件订阅的事件。 不支持通配符。

--subject-ends-with

用于筛选基于后缀的事件订阅事件的可选字符串。 不支持通配符。

--subscription

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