共用方式為


az eventgrid partner topic event-subscription

注意

此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。 安裝每個擴充功能以受益于其擴充功能。 深入了解擴充功能。

管理合作夥伴主題的事件訂閱。

命令

名稱 Description 類型 狀態
az eventgrid partner topic event-subscription create

建立合作夥伴主題的新事件訂用帳戶。

核心 GA
az eventgrid partner topic event-subscription create (eventgrid 擴充功能)

建立合作夥伴主題的新事件訂用帳戶。

副檔名 預覽版
az eventgrid partner topic event-subscription delete

刪除合作夥伴主題的事件訂閱。

核心 GA
az eventgrid partner topic event-subscription delete (eventgrid 擴充功能)

刪除合作夥伴主題的事件訂閱。

副檔名 預覽版
az eventgrid partner topic event-subscription list

列出特定合作夥伴主題的事件訂閱。

核心 GA
az eventgrid partner topic event-subscription list (eventgrid 擴充功能)

列出特定合作夥伴主題的事件訂閱。

副檔名 預覽版
az eventgrid partner topic event-subscription show

取得合作夥伴主題的事件訂用帳戶詳細資料。

核心 GA
az eventgrid partner topic event-subscription show (eventgrid 擴充功能)

取得合作夥伴主題的事件訂用帳戶詳細資料。

副檔名 預覽版
az eventgrid partner topic event-subscription update

更新合作夥伴主題的事件訂閱。

核心 GA
az eventgrid partner topic event-subscription update (eventgrid 擴充功能)

更新合作夥伴主題的事件訂閱。

副檔名 預覽版

az eventgrid partner topic event-subscription create

建立合作夥伴主題的新事件訂用帳戶。

az eventgrid partner topic event-subscription create --name
                                                     --partner-topic-name
                                                     --resource-group
                                                     [--aad-tenant-id]
                                                     [--advanced-filter]
                                                     [--azure-active-directory-application-id-or-uri]
                                                     [--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]

範例

使用預設篩選,為事件方格夥伴主題建立新的事件訂用帳戶。

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

為 Event Grid 合作夥伴主題建立新的事件訂用帳戶,並指定主旨前置詞的篩選準則。

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

使用預設篩選準則和 CloudEvent V 1.0 作為傳遞架構,為 Event Grid 合作夥伴主題建立新的事件訂用帳戶。

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

為事件方格合作夥伴建立新的事件訂用帳戶,並具有死電目的地和自訂重試原則上限為 10 次傳遞嘗試,以及事件 TTL 為 2 小時(無論稍早發生)和到期日。

az eventgrid partner topic event-subscription create --name es2 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 作為目的地,為 Event Grid 合作夥伴主題建立新的事件訂用帳戶。

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

使用 Azure Function 作為目的地,為 Event Grid 合作夥伴主題建立新的事件訂用帳戶。

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

使用儲存體佇列作為目的地,在 5 分鐘時建立事件方格合作夥伴主題的新事件訂用帳戶

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

為已啟用陣列的進階篩選事件方格合作夥伴主題建立新的事件訂用帳戶

az eventgrid partner topic event-subscription create -n es1 \
    -g rg1 --partner-topic-name partnertopic1 \
    --endpoint-type storagequeue \
    --endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
    --enable-advanced-filtering-on-arrays true

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--aad-tenant-id --azure-active-directory-tenant-id

Azure Active Directory 租使用者識別碼,以取得存取權杖,這些權杖將包含在傳遞要求中作為持有人權杖。 僅適用于 Webhook 作為目的地。

--advanced-filter

進階篩選會根據特定事件屬性來篩選事件。

使用方式:--advanced-filter KEY[。INNERKEY] FILTEROPERATOR 值 [VALUE ...]StringIn:-advanced-filter 資料。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter 資料。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBeginsWith: --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg NumberIn: --advanced-filterdata.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange: --advanced-filter data.property2 NumberNotInRange 100,110 200,210 300,310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined IsNotNull: --advanced-filter data.property3 IsNotNull 多個進階篩選可以使用多個 --advanced-filter 引數來指定。

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

Azure Active Directory 應用程式識別碼或 URI,以取得存取權杖,這些權杖將包含在傳遞要求中作為持有人權杖。 僅適用于 Webhook 作為目的地。

--deadletter-endpoint

Azure 儲存體 Blob 容器目的地的 Azure 資源識別碼,其中 EventGrid 應該為此事件訂用帳戶造成無法傳遞的事件。

範例:-deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft。儲存體/storageAccounts/sa1/blobServices/default/containers/containerName。

--delivery-attribute-mapping

新增傳遞屬性對應,以在傳遞事件時透過 HTTP 標頭傳送其他資訊。 此屬性適用于所有目的地類型,但 儲存體Queue 除外。 您可以使用多個 --delivery-attribute-mapping 引數來指定多個屬性。

使用方式:--delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Both Static and Dynamic:delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue。

--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 topic-type list-event-types'查詢其事件種類。

--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
預設值: False
--subject-ends-with

選擇性字串,可根據尾碼篩選事件訂閱的事件。 不支援萬用字元。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription create (eventgrid 擴充功能)

預覽

命令群組 'az eventgrid' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

建立合作夥伴主題的新事件訂用帳戶。

az eventgrid partner topic event-subscription create --name
                                                     --partner-topic-name
                                                     --resource-group
                                                     [--advanced-filter]
                                                     [--azure-active-directory-application-id-or-uri]
                                                     [--azure-active-directory-tenant-id]
                                                     [--deadletter-endpoint]
                                                     [--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]
                                                     [--subject-begins-with]
                                                     [--subject-case-sensitive {false, true}]
                                                     [--subject-ends-with]

範例

使用預設篩選,為事件方格夥伴主題建立新的事件訂用帳戶。

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

為 Event Grid 合作夥伴主題建立新的事件訂用帳戶,並指定主旨前置詞的篩選準則。

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

使用預設篩選準則和 CloudEvent V 1.0 作為傳遞架構,為 Event Grid 合作夥伴主題建立新的事件訂用帳戶。

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

為事件方格合作夥伴建立新的事件訂用帳戶,並具有死電目的地和自訂重試原則上限為 10 次傳遞嘗試,以及事件 TTL 為 2 小時(無論稍早發生)和到期日。

az eventgrid partner topic event-subscription create --name es2 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 作為目的地,為 Event Grid 合作夥伴主題建立新的事件訂用帳戶。

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

使用 Azure Function 作為目的地,為 Event Grid 合作夥伴主題建立新的事件訂用帳戶。

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

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--advanced-filter

進階篩選會根據特定事件屬性來篩選事件。

使用方式:--advanced-filter KEY[。INNERKEY] FILTEROPERATOR 值 [VALUE ...]StringIn:-advanced-filter 資料。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter 資料。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg NumberIn: --advanced--filter subject StringEndsWith filter data.property1 NumberIn 5 10 20 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filterdata.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true 使用多個 --advanced-filter 引數來指定多個進階篩選。

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

Azure Active Directory 應用程式識別碼或 URI,以取得存取權杖,這些權杖將包含在傳遞要求中作為持有人權杖。 僅適用于 Webhook 作為目的地。

--azure-active-directory-tenant-id

Azure Active Directory 租使用者識別碼,以取得存取權杖,這些權杖將包含在傳遞要求中作為持有人權杖。 僅適用于 Webhook 作為目的地。

--deadletter-endpoint

Azure 儲存體 Blob 容器目的地的 Azure 資源識別碼,其中 EventGrid 應該為此事件訂用帳戶造成無法傳遞的事件。

範例:-deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft。儲存體/storageAccounts/sa1/blobServices/default/containers/containerName。

--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。 若要訂閱所有預設事件種類,請勿為此引數指定任何值。

--labels

與這個事件訂用帳戶相關聯的標籤以空格分隔的清單。

--max-delivery-attempts

傳遞嘗試次數上限。 必須是介於 1 到 30 之間的數位。

預設值: 30
--max-events-per-batch

批次中的事件數目上限。 必須是介於 1 到 5000 之間的數位。

--preferred-batch-size-in-kilobytes

慣用的批次大小以 KB 為單位。 必須是介於 1 到 1024 之間的數位。

--subject-begins-with

選擇性字串,可根據前置詞篩選事件訂閱的事件。 不支援萬用字元。

--subject-case-sensitive

指定 以指出是否應該以區分大小寫的方式比較主旨欄位。 如果旗標存在,則為 True。

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

選擇性字串,可根據尾碼篩選事件訂閱的事件。 不支援萬用字元。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription delete

刪除合作夥伴主題的事件訂閱。

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

範例

刪除事件方格合作夥伴主題的事件訂用帳戶。

az eventgrid partner topic event-subscription delete --name es1 \
    -g rg1 --partner-topic-name partnertopic1 \

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--yes -y

不提示確認。

預設值: False
全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription delete (eventgrid 擴充功能)

預覽

命令群組 'az eventgrid' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

刪除合作夥伴主題的事件訂閱。

az eventgrid partner topic event-subscription delete --name
                                                     --partner-topic-name
                                                     --resource-group

範例

刪除事件方格合作夥伴主題的事件訂用帳戶。

az eventgrid partner topic event-subscription delete --name es1 \
    -g rg1 --partner-topic-name partnertopic1 \

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription list

列出特定合作夥伴主題的事件訂閱。

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

範例

列出為事件方格合作夥伴主題建立的所有事件訂用帳戶。

az eventgrid partner topic event-subscription list -g rg1 --partner-topic-name partnertopic1

必要參數

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--odata-query

用於篩選清單結果的 OData 查詢。 [名稱] 屬性目前只允許篩選。 支援的作業包括:CONTAINS、eq (等於)、ne (不等於)、AND、OR 和 NOT。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription list (eventgrid 擴充功能)

預覽

命令群組 'az eventgrid' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

列出特定合作夥伴主題的事件訂閱。

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

範例

列出為事件方格合作夥伴主題建立的所有事件訂用帳戶。

az eventgrid partner topic event-subscription list -g rg1 --partner-topic-name partnertopic1

必要參數

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--odata-query

用來使用 OData 語法篩選結果的查詢。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription show

取得合作夥伴主題的事件訂用帳戶詳細資料。

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

範例

顯示事件方格合作夥伴主題的事件訂用帳戶詳細資料。

az eventgrid partner topic event-subscription show --name es1 \
     -g rg1 --partner-topic-name partnertopic1

顯示事件方格合作夥伴主題的事件訂用帳戶詳細資料,並包含靜態傳遞屬性秘密

az eventgrid partner topic event-subscription show --name es1 \
     -g rg1 --partner-topic-name partnertopic1 --include-static-delivery-attribute-secret

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

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

指出是否應該傳回任何靜態傳遞屬性秘密。 如果旗標存在,則為 True。

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

指定 以指出是否應該傳回完整的端點 URL。 如果旗標存在,則為 True。

接受的值: false, true
預設值: False
全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription show (eventgrid 擴充功能)

預覽

命令群組 'az eventgrid' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

取得合作夥伴主題的事件訂用帳戶詳細資料。

az eventgrid partner topic event-subscription show --name
                                                   --partner-topic-name
                                                   --resource-group
                                                   [--include-full-endpoint-url {false, true}]

範例

顯示事件方格合作夥伴主題的事件訂用帳戶詳細資料。

az eventgrid partner topic event-subscription show --name es1 \
     -g rg1 --partner-topic-name partnertopic1

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--include-full-endpoint-url

指定 以指出是否應該傳回完整的端點 URL。 如果旗標存在,則為 True。

接受的值: false, true
預設值: False
全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription update

更新合作夥伴主題的事件訂閱。

az eventgrid partner topic event-subscription update --name
                                                     --partner-topic-name
                                                     --resource-group
                                                     [--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]

範例

更新事件方格合作夥伴主題的事件訂用帳戶,以指定新的端點。

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

更新事件方格合作夥伴主題的事件訂閱,以指定具有篩選準則的新主旨端。

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

更新事件方格夥伴主題的事件訂用帳戶,以指定新的端點和新的主旨端,並篩選包含的事件種類新清單。

az eventgrid partner topic event-subscription update --name es3 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 partner topic event-subscription update --name es2 \
    -g rg1 --partner-topic-name partnertopic1 \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1

使用進階篩選,更新Azure 事件方格合作夥伴主題的事件訂閱。

az eventgrid partner topic event-subscription update --name es3 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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

使用儲存體佇列作為目的地,在 5 分鐘時更新 Event Grid 合作夥伴主題的事件訂用帳戶

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

針對已啟用陣列的進階篩選,更新 Event Grid 合作夥伴主題的事件訂用帳戶

az eventgrid partner topic event-subscription update -n es1 \
    -g rg1 --partner-topic-name partnertopic1 \
    --endpoint-type storagequeue \
    --endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
    --enable-advanced-filtering-on-arrays true

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--advanced-filter

進階篩選會根據特定事件屬性來篩選事件。

使用方式:--advanced-filter KEY[。INNERKEY] FILTEROPERATOR 值 [VALUE ...]StringIn:-advanced-filter 資料。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter 資料。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBeginsWith: --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg NumberIn: --advanced-filterdata.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange: --advanced-filter data.property2 NumberNotInRange 100,110 200,210 300,310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined IsNotNull: --advanced-filter data.property3 IsNotNull 多個進階篩選可以使用多個 --advanced-filter 引數來指定。

--deadletter-endpoint

Azure 儲存體 Blob 容器目的地的 Azure 資源識別碼,其中 EventGrid 應該為此事件訂用帳戶造成無法傳遞的事件。

--delivery-attribute-mapping

新增傳遞屬性對應,以在傳遞事件時透過 HTTP 標頭傳送其他資訊。 此屬性適用于所有目的地類型,但 儲存體Queue 除外。 您可以使用多個 --delivery-attribute-mapping 引數來指定多個屬性。

使用方式:--delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Both Static and Dynamic:delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue。

--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 topic-type list-event-types'查詢其事件種類。

--labels

與這個事件訂用帳戶相關聯的標籤以空格分隔的清單。

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

儲存體佇列訊息存留時間以秒為單位。

--subject-begins-with

選擇性字串,可根據前置詞篩選事件訂閱的事件。 不支援萬用字元。

--subject-ends-with

選擇性字串,可根據尾碼篩選事件訂閱的事件。 不支援萬用字元。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az eventgrid partner topic event-subscription update (eventgrid 擴充功能)

預覽

命令群組 'az eventgrid' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

更新合作夥伴主題的事件訂閱。

az eventgrid partner topic event-subscription update --name
                                                     --partner-topic-name
                                                     --resource-group
                                                     [--advanced-filter]
                                                     [--deadletter-endpoint]
                                                     [--endpoint]
                                                     [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                     [--included-event-types]
                                                     [--labels]
                                                     [--subject-begins-with]
                                                     [--subject-ends-with]

範例

更新事件方格合作夥伴主題的事件訂用帳戶,以指定新的端點。

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

更新事件方格合作夥伴主題的事件訂閱,以指定具有篩選準則的新主旨端。

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

更新事件方格夥伴主題的事件訂用帳戶,以指定新的端點和新的主旨端,並篩選包含的事件種類新清單。

az eventgrid partner topic event-subscription update --name es3 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 partner topic event-subscription update --name es2 \
    -g rg1 --partner-topic-name partnertopic1 \
    --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1

使用進階篩選,更新Azure 事件方格合作夥伴主題的事件訂閱。

az eventgrid partner topic event-subscription update --name es3 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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

必要參數

--name -n

事件訂閱的名稱。

--partner-topic-name

合作夥伴主題的名稱。

--resource-group -g

資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--advanced-filter

進階篩選會根據特定事件屬性來篩選事件。

使用方式:--advanced-filter KEY[。INNERKEY] FILTEROPERATOR 值 [VALUE ...]StringIn:-advanced-filter 資料。Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter 資料。Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg NumberIn: --advanced--filter subject StringEndsWith filter data.property1 NumberIn 5 10 20 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filterdata.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true 使用多個 --advanced-filter 引數來指定多個進階篩選。

--deadletter-endpoint

Azure 儲存體 Blob 容器目的地的 Azure 資源識別碼,其中 EventGrid 應該為此事件訂用帳戶造成無法傳遞的事件。

--endpoint

EventGrid 應傳遞符合此事件訂用帳戶的事件的端點。 針對 Webhook 端點類型,這應該是對應的 Webhook URL。 對於其他端點類型,這應該是端點的 Azure 資源識別碼。

--endpoint-type

目的地端點的類型。

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

以空格分隔的事件種類清單。 範例:Microsoft。儲存體。BlobCreated Microsoft。儲存體。BlobDeleted。 若要訂閱所有預設事件種類,請勿為此引數指定任何值。

--labels

與這個事件訂用帳戶相關聯的標籤以空格分隔的清單。

--subject-begins-with

選擇性字串,可根據前置詞篩選事件訂閱的事件。 不支援萬用字元。

--subject-ends-with

選擇性字串,可根據尾碼篩選事件訂閱的事件。 不支援萬用字元。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。