az eventgrid domain topic event-subscription
管理網域主題的事件訂閱。
命令
名稱 | Description | 類型 | 狀態 |
---|---|---|---|
az eventgrid domain topic event-subscription create |
建立網域主題的新事件訂用帳戶。 |
核心 | GA |
az eventgrid domain topic event-subscription delete |
刪除網域主題的事件訂用帳戶。 |
核心 | GA |
az eventgrid domain topic event-subscription list |
列出特定網域主題的事件訂閱。 |
核心 | GA |
az eventgrid domain topic event-subscription show |
取得網域主題的事件訂用帳戶詳細資料。 |
核心 | GA |
az eventgrid domain topic event-subscription update |
更新網域主題的事件訂閱。 |
核心 | GA |
az eventgrid domain topic event-subscription create
建立網域主題的新事件訂用帳戶。
az eventgrid domain topic event-subscription create --domain-name
--domain-topic-name
--name
--resource-group
[--aad-app-id]
[--aad-tenant-id]
[--advanced-filter]
[--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]
[--pref-batch-size-kb]
[--qttl]
[--subject-begins-with]
[--subject-case-sensitive {false, true}]
[--subject-ends-with]
範例
使用預設篩選,為事件方格網域主題建立新的事件訂用帳戶。
az eventgrid domain topic event-subscription create --name es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
為 Event Grid 網域主題建立新的事件訂用帳戶,並指定主旨前置詞的篩選準則。
az eventgrid domain topic event-subscription create --name es4 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--subject-begins-with mysubject_prefix
使用預設篩選準則和 CloudEvent V 1.0 作為傳遞架構,為 Event Grid 網域主題建立新的事件訂用帳戶。
az eventgrid domain topic event-subscription create -n es2 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--event-delivery-schema cloudeventschemav1_0
為事件方格網域主題建立新的事件訂用帳戶,其目的地和自訂重試原則上限為 10 次傳遞嘗試,以及 2 小時的事件 TTL 和到期日。
az eventgrid domain topic event-subscription create --name es2 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--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 domain topic event-subscription create --name es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--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 作為目的地,為事件方格網域主題建立新的事件訂用帳戶。
az eventgrid domain topic event-subscription create -n es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction
使用 儲存體 Queue 作為目的地,建立事件方格網域主題的新事件訂用帳戶,其 ttl 為 5 分鐘
az eventgrid domain topic event-subscription create -n es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--endpoint-type storagequeue \
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
--storage-queue-msg-ttl 300
建立事件方格網域主題的新事件訂用帳戶,並在陣列上啟用進階篩選
az eventgrid domain topic event-subscription create -n es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction \
--enable-advanced-filtering-on-arrays true
必要參數
功能變數名稱。
網域主題的名稱。
事件訂閱的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
選擇性參數
Azure Active Directory 應用程式識別碼或 URI,以取得存取權杖,這些權杖將包含在傳遞要求中作為持有人權杖。 僅適用于 Webhook 作為目的地。
Azure Active Directory 租使用者識別碼,以取得存取權杖,這些權杖將包含在傳遞要求中作為持有人權杖。 僅適用于 Webhook 作為目的地。
進階篩選會根據特定事件屬性來篩選事件。
使用方式:--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 儲存體 Blob 容器目的地的 Azure 資源識別碼,其中 EventGrid 應該為此事件訂用帳戶造成無法傳遞的事件。
範例:-deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft。儲存體/storageAccounts/sa1/blobServices/default/containers/containerName。
新增傳遞屬性對應,以在傳遞事件時透過 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。
允許針對值的陣列評估進階篩選,而不是預期單一值。
EventGrid 應傳遞符合此事件訂用帳戶的事件的端點。 針對 Webhook 端點類型,這應該是對應的 Webhook URL。 對於其他端點類型,這應該是端點的 Azure 資源識別碼。 預期目的地端點已建立並可供使用,再執行任何事件方格命令。
目的地端點的類型。
應該為此事件訂閱傳遞事件的架構。 根據預設,事件會以發行的相同架構傳遞(根據對應主題的輸入架構)。
活動存留時間(以分鐘為單位)。 必須是介於 1 到 1440 之間的數位。
日期或日期時間 (UTC,例如 '2018-11-30T11:59:59+00:00' 或 '2018-11-30'),之後事件訂閱將會到期。 根據預設,事件訂用帳戶沒有到期日。
以空格分隔的事件種類清單(例如 Microsoft.儲存體。BlobCreated 和 Microsoft。儲存體。BlobDeleted)。 若要訂閱所有預設事件種類,請勿為此引數指定任何值。 針對事件方格主題,事件種類是客戶定義的。 針對 Azure 事件,例如儲存體帳戶、IoT 中樞等,您可以使用此 CLI 命令 'az eventgrid topic-type list-event-types'查詢其事件種類。
與這個事件訂用帳戶相關聯的標籤以空格分隔的清單。
傳遞嘗試次數上限。 必須是介於 1 到 30 之間的數位。
批次中的事件數目上限。 必須是介於 1 到 5000 之間的數位。
慣用的批次大小以 KB 為單位。 必須是介於 1 到 1024 之間的數位。
儲存體佇列訊息存留時間以秒為單位。
選擇性字串,可根據前置詞篩選事件訂閱的事件。 不支援萬用字元。
指定 以指出是否應該以區分大小寫的方式比較主旨欄位。 如果旗標存在,則為 True。
選擇性字串,可根據尾碼篩選事件訂閱的事件。 不支援萬用字元。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az eventgrid domain topic event-subscription delete
刪除網域主題的事件訂用帳戶。
az eventgrid domain topic event-subscription delete --domain-name
--domain-topic-name
--name
--resource-group
[--yes]
範例
刪除事件方格網域主題的事件訂用帳戶。
az eventgrid domain topic event-subscription delete --name es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
必要參數
功能變數名稱。
網域主題的名稱。
事件訂閱的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
選擇性參數
不提示確認。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az eventgrid domain topic event-subscription list
列出特定網域主題的事件訂閱。
az eventgrid domain topic event-subscription list --domain-name
--domain-topic-name
--resource-group
[--odata-query]
範例
列出為事件方格網域主題建立的所有事件訂用帳戶。
az eventgrid domain topic event-subscription list -g rg1 --domain-name domain1 --domain-topic-name topic1
必要參數
功能變數名稱。
網域主題的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
選擇性參數
用於篩選清單結果的 OData 查詢。 [名稱] 屬性目前只允許篩選。 支援的作業包括:CONTAINS、eq (等於)、ne (不等於)、AND、OR 和 NOT。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az eventgrid domain topic event-subscription show
取得網域主題的事件訂用帳戶詳細資料。
az eventgrid domain topic event-subscription show --domain-name
--domain-topic-name
--name
--resource-group
[--full-ed-url {false, true}]
[--include-attrib-secret {false, true}]
範例
顯示事件方格網域主題的事件訂用帳戶詳細資料。
az eventgrid domain topic event-subscription show --name es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1
顯示事件方格網域主題的事件訂用帳戶詳細資料,包括任何靜態傳遞屬性秘密。
az eventgrid domain topic event-subscription show --name es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 --include-attrib-secret
必要參數
功能變數名稱。
網域主題的名稱。
事件訂閱的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
選擇性參數
指定 以指出是否應該傳回完整的端點 URL。 如果旗標存在,則為 True。
指出是否應該傳回任何靜態傳遞屬性秘密。 如果旗標存在,則為 True。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az eventgrid domain topic event-subscription update
更新網域主題的事件訂閱。
az eventgrid domain topic event-subscription update --domain-name
--domain-topic-name
--name
--resource-group
[--advanced-filter]
[--deadletter-endpoint]
[--delivery-attribute-mapping]
[--enable-advanced-filtering-on-arrays {false, true}]
[--endpoint]
[--included-event-types]
[--labels]
[--qttl]
[--subject-begins-with]
[--subject-ends-with]
[--update-endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
範例
更新事件方格網域主題的事件訂用帳戶,以指定新的端點。
az eventgrid domain topic event-subscription update --name es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code
更新事件方格網域主題的事件訂用帳戶,以指定具有篩選準則的新主旨端點。
az eventgrid domain topic event-subscription update --name es2 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--subject-ends-with .jpg
更新事件方格網域主題的事件訂用帳戶,以指定新的端點和新的主旨端點,並篩選包含事件種類的新清單。
az eventgrid domain topic event-subscription update --name es3 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--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 domain topic event-subscription update --name es2 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1
使用進階篩選,更新Azure 事件方格網域主題的事件訂用帳戶。
az eventgrid domain topic event-subscription update --name es3 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--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
使用 儲存體 Queue 作為目的地,更新事件方格網域主題的事件訂用帳戶,ttl 為 5 分鐘
az eventgrid domain topic event-subscription update -n es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--storage-queue-msg-ttl 300
使用已啟用陣列的進階篩選,更新事件方格網域主題的事件訂用帳戶
az eventgrid domain topic event-subscription update -n es1 \
-g rg1 --domain-name domain1 --domain-topic-name topic1 \
--enable-advanced-filtering-on-arrays true
必要參數
功能變數名稱。
網域主題的名稱。
事件訂閱的名稱。
資源組名。 您可以使用 來設定預設群組 az configure --defaults group=<name>
。
選擇性參數
進階篩選會根據特定事件屬性來篩選事件。
使用方式:--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 儲存體 Blob 容器目的地的 Azure 資源識別碼,其中 EventGrid 應該為此事件訂用帳戶造成無法傳遞的事件。
新增傳遞屬性對應,以在傳遞事件時透過 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。
允許針對值的陣列評估進階篩選,而不是預期單一值。
EventGrid 應傳遞符合此事件訂用帳戶的事件的端點。 針對 Webhook 端點類型,這應該是對應的 Webhook URL。 對於其他端點類型,這應該是端點的 Azure 資源識別碼。 預期目的地端點已建立並可供使用,再執行任何事件方格命令。
以空格分隔的事件種類清單(例如 Microsoft.儲存體。BlobCreated 和 Microsoft。儲存體。BlobDeleted)。 若要訂閱所有預設事件種類,請勿為此引數指定任何值。 針對事件方格主題,事件種類是客戶定義的。 針對 Azure 事件,例如儲存體帳戶、IoT 中樞等,您可以使用此 CLI 命令 'az eventgrid topic-type list-event-types'查詢其事件種類。
與這個事件訂用帳戶相關聯的標籤以空格分隔的清單。
儲存體佇列訊息存留時間以秒為單位。
選擇性字串,可根據前置詞篩選事件訂閱的事件。 不支援萬用字元。
選擇性字串,可根據尾碼篩選事件訂閱的事件。 不支援萬用字元。
目的地端點的類型。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。