Event Subscriptions - List Global By Resource Group For Topic Type
列出資源群組下的所有全域事件訂用帳戶,以取得主題類型。
列出資源群組下的特定主題類型的所有全域事件訂用帳戶。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions?api-version=2022-06-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions?api-version=2022-06-15&$filter={$filter}&$top={$top}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
用戶訂用帳戶內的資源組名。 |
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
topic
|
path | True |
string |
主題類型的名稱。 |
api-version
|
query | True |
string |
要與用戶端要求搭配使用的 API 版本。 |
$filter
|
query |
string |
用來使用 OData 語法篩選搜尋結果的查詢。 只允許篩選 『name』 屬性,且 OData 作業數目有限。 這些作業包括:'contains' 函式以及下列邏輯作業:not、and、或 eq (表示相等) ,而 ne (表示不等於) 。 不支持算術運算。 以下是有效的篩選範例:$filter=contains (namE、'PATTERN') 和 name ne 'PATTERN-1'。 下列不是有效的篩選範例:$filter=location eq 'westus'。 |
|
$top
|
query |
integer int32 |
要針對清單作業傳回每頁的結果數目。 top 參數的有效範圍是 1 到 100。 如果未指定,則傳回的默認結果數目為每頁 20 個專案。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
錯誤回應: ≦
|
範例
EventSubscriptions_ListGlobalByResourceGroupForTopicType
Sample Request
GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topicTypes/Microsoft.Resources.ResourceGroups/eventSubscriptions?api-version=2022-06-15
Sample Response
{
"value": [
{
"properties": {
"destination": {
"properties": {
"endpointBaseUrl": "https://requestb.in/15ksip71"
},
"endpointType": "WebHook"
},
"filter": {
"isSubjectCaseSensitive": false,
"subjectBeginsWith": "ExamplePrefix",
"subjectEndsWith": "ExampleSuffix"
},
"labels": [
"Finance",
"HR"
],
"provisioningState": "Succeeded",
"topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
},
"id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
"name": "examplesubscription3",
"type": "Microsoft.EventGrid/eventSubscriptions"
}
]
}
定義
AzureFunctionEventSubscriptionDestination
事件訂用帳戶的 Azure 函式目的地相關信息。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
endpointType |
string:
Azure |
事件訂用帳戶目的地的端點類型。 |
|
properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
傳遞屬性詳細數據。 |
|
properties.maxEventsPerBatch |
integer |
1 |
每個批次的事件數目上限。 |
properties.preferredBatchSizeInKilobytes |
integer |
64 |
慣用的批次大小以 KB 為單位。 |
properties.resourceId |
string |
Azure 資源識別碼,表示事件訂用帳戶之 Azure 函式目的地的端點。 |
BoolEqualsAdvancedFilter
BoolEquals 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Bool |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
value |
boolean |
布爾篩選值。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DeadLetterWithResourceIdentity
具有資源識別的寄不出的目的地相關信息。
名稱 | 類型 | Description |
---|---|---|
deadLetterDestination | DeadLetterDestination: |
事件訂用帳戶必須傳遞事件之目的地的相關信息。 在父資源上使用受控識別設定 (,也就是主題或網域) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
identity |
死信事件時要使用的身分識別。 |
DeliveryWithResourceIdentity
使用資源識別傳遞事件訂用帳戶的相關信息。
名稱 | 類型 | Description |
---|---|---|
destination | EventSubscriptionDestination: |
事件訂用帳戶必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
identity |
傳遞事件時要使用的身分識別。 |
DynamicDeliveryAttributeMapping
動態傳遞屬性對應詳細數據。
名稱 | 類型 | Description |
---|---|---|
name |
string |
傳遞屬性或標頭的名稱。 |
properties.sourceField |
string |
事件中包含屬性值的 JSON 路徑。 |
type |
string:
Dynamic |
傳遞屬性或標頭名稱的類型。 |
EventDeliverySchema
事件訂閱的事件傳遞架構。
名稱 | 類型 | Description |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomInputSchema |
string |
|
EventGridSchema |
string |
EventHubEventSubscriptionDestination
事件訂用帳戶之事件中樞目的地的相關信息。
名稱 | 類型 | Description |
---|---|---|
endpointType |
string:
Event |
事件訂用帳戶目的地的端點類型。 |
properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
傳遞屬性詳細數據。 |
properties.resourceId |
string |
Azure 資源識別碼,表示事件訂用帳戶事件中樞目的地的端點。 |
EventSubscription
事件訂閱
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
id |
string |
資源的完整標識碼。 |
|
name |
string |
資源名稱。 |
|
properties.deadLetterDestination | DeadLetterDestination: |
事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
|
properties.deadLetterWithResourceIdentity |
事件訂閱的寄不出的信件目的地。 無法傳遞至目的地的任何事件都會傳送至寄不出的信件目的地。 在父資源上使用受控識別設定 (,也就是主題或網域) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
||
properties.deliveryWithResourceIdentity |
事件訂用帳戶必須傳遞事件之目的地的相關信息。 在父資源上使用受控識別設定 (,也就是主題或網域) ,以取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
||
properties.destination | EventSubscriptionDestination: |
事件訂用帳戶必須傳遞事件之目的地的相關信息。 使用 Azure 事件方格 的身分識別來取得傳遞/寄不出的信件期間所使用的驗證令牌。 |
|
properties.eventDeliverySchema | EventGridSchema |
事件訂閱的事件傳遞架構。 |
|
properties.expirationTimeUtc |
string |
事件訂閱的到期時間。 |
|
properties.filter |
事件訂閱篩選的相關信息。 |
||
properties.labels |
string[] |
使用者定義標籤的清單。 |
|
properties.provisioningState |
事件訂閱的布建狀態。 |
||
properties.retryPolicy |
事件的重試原則。 這可以用來設定事件的最大傳遞嘗試次數和存留時間。 |
||
properties.topic |
string |
事件訂用帳戶的主題名稱。 |
|
systemData |
與事件訂用帳戶資源相關的系統元數據。 |
||
type |
string |
資源類型。 |
EventSubscriptionFilter
篩選事件訂閱。
EventSubscriptionIdentity
事件訂用帳戶的身分識別資訊。
名稱 | 類型 | Description |
---|---|---|
type |
使用的受控識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。 |
|
userAssignedIdentity |
string |
與資源相關聯的使用者身分識別。 |
EventSubscriptionIdentityType
使用的受控識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。
名稱 | 類型 | Description |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
EventSubscriptionProvisioningState
事件訂閱的布建狀態。
名稱 | 類型 | Description |
---|---|---|
AwaitingManualAction |
string |
|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
EventSubscriptionsListResult
List EventSubscriptions 作業的結果
名稱 | 類型 | Description |
---|---|---|
nextLink |
string |
事件訂用帳戶下一頁的連結 |
value |
EventSubscriptions 的集合 |
HybridConnectionEventSubscriptionDestination
事件訂用帳戶的 HybridConnection 目的地相關信息。
名稱 | 類型 | Description |
---|---|---|
endpointType |
string:
Hybrid |
事件訂用帳戶目的地的端點類型。 |
properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
傳遞屬性詳細數據。 |
properties.resourceId |
string |
屬於事件訂用帳戶目的地之混合式連線的 Azure 資源識別碼。 |
IsNotNullAdvancedFilter
IsNotNull 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Is |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
IsNullOrUndefinedAdvancedFilter
IsNullOrUndefined Advanced Filter。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Is |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
NumberGreaterThanAdvancedFilter
NumberGreaterThan 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
value |
number |
篩選值。 |
NumberGreaterThanOrEqualsAdvancedFilter
NumberGreaterThanOrEquals 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
value |
number |
篩選值。 |
NumberInAdvancedFilter
NumberIn 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
number[] |
篩選值集。 |
NumberInRangeAdvancedFilter
NumberInRange 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
number[] |
篩選值集。 |
NumberLessThanAdvancedFilter
NumberLessThan Advanced Filter。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
value |
number |
篩選值。 |
NumberLessThanOrEqualsAdvancedFilter
NumberLessThanOrEquals 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
value |
number |
篩選值。 |
NumberNotInAdvancedFilter
NumberNotIn 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
number[] |
篩選值集。 |
NumberNotInRangeAdvancedFilter
NumberNotInRange 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
Number |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
number[] |
篩選值集。 |
RetryPolicy
事件訂閱重試原則的相關信息。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
eventTimeToLiveInMinutes |
integer |
1440 |
活動) 分鐘 (存留時間。 |
maxDeliveryAttempts |
integer |
30 |
事件的傳遞重試嘗試次數上限。 |
ServiceBusQueueEventSubscriptionDestination
事件訂用帳戶的服務總線目的地相關信息。
名稱 | 類型 | Description |
---|---|---|
endpointType |
string:
Service |
事件訂用帳戶目的地的端點類型。 |
properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
傳遞屬性詳細數據。 |
properties.resourceId |
string |
Azure 資源識別碼,表示事件訂用帳戶之服務總線目的地的端點。 |
ServiceBusTopicEventSubscriptionDestination
事件訂用帳戶的服務總線主題目的地相關信息。
名稱 | 類型 | Description |
---|---|---|
endpointType |
string:
Service |
事件訂用帳戶目的地的端點類型。 |
properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
傳遞屬性詳細數據。 |
properties.resourceId |
string |
Azure 資源標識碼,表示事件訂用帳戶之服務總線主題目的地的端點。 |
StaticDeliveryAttributeMapping
靜態傳遞屬性對應詳細數據。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
name |
string |
傳遞屬性或標頭的名稱。 |
|
properties.isSecret |
boolean |
False |
布林值旗標,指出屬性是否包含敏感性資訊 。 |
properties.value |
string |
傳遞屬性的值。 |
|
type |
string:
Static |
傳遞屬性或標頭名稱的類型。 |
StorageBlobDeadLetterDestination
記憶體 Blob 型寄不出的信件目的地的相關信息。
名稱 | 類型 | Description |
---|---|---|
endpointType |
string:
Storage |
無效信件目的地的端點類型 |
properties.blobContainerName |
string |
記憶體 Blob 容器的名稱,該容器是寄不出的事件目的地 |
properties.resourceId |
string |
記憶體帳戶的 Azure 資源識別符,該帳戶是死信事件目的地 |
StorageQueueEventSubscriptionDestination
事件訂用帳戶的記憶體佇列目的地相關信息。
名稱 | 類型 | Description |
---|---|---|
endpointType |
string:
Storage |
事件訂用帳戶目的地的端點類型。 |
properties.queueMessageTimeToLiveInSeconds |
integer |
儲存佇列訊息存留時間,以秒為單位。 |
properties.queueName |
string |
記憶體帳戶下記憶體佇列的名稱,該帳戶是事件訂用帳戶的目的地。 |
properties.resourceId |
string |
記憶體帳戶的 Azure 資源識別碼,其中包含事件訂用帳戶目的地的佇列。 |
StringBeginsWithAdvancedFilter
StringBeginsWith 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
StringContainsAdvancedFilter
StringContains 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
StringEndsWithAdvancedFilter
StringEndsWith 進階篩選條件。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
StringInAdvancedFilter
StringIn 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
StringNotBeginsWithAdvancedFilter
StringNotBeginsWith 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
StringNotContainsAdvancedFilter
StringNotContains 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
StringNotEndsWithAdvancedFilter
StringNotEndsWith 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
StringNotInAdvancedFilter
StringNotIn 進階篩選。
名稱 | 類型 | Description |
---|---|---|
key |
string |
事件中的欄位/屬性,根據您要篩選的欄位/屬性。 |
operatorType |
string:
String |
用於篩選的運算符類型,例如 NumberIn、StringContains、BoolEquals 等等。 |
values |
string[] |
篩選值集。 |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |
WebHookEventSubscriptionDestination
事件訂用帳戶的 Webhook 目的地相關信息。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
endpointType |
string:
Web |
事件訂用帳戶目的地的端點類型。 |
|
properties.azureActiveDirectoryApplicationIdOrUri |
string |
Azure Active Directory 應用程式識別碼或 URI,以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 |
|
properties.azureActiveDirectoryTenantId |
string |
Azure Active Directory 租使用者識別符,以取得將包含在傳遞要求中作為持有人令牌的存取令牌。 |
|
properties.deliveryAttributeMappings | DeliveryAttributeMapping[]: |
傳遞屬性詳細數據。 |
|
properties.endpointBaseUrl |
string |
基底 URL,表示事件訂用帳戶目的地的端點。 |
|
properties.endpointUrl |
string |
URL,表示事件訂用帳戶目的地的端點。 |
|
properties.maxEventsPerBatch |
integer |
1 |
每個批次的事件數目上限。 |
properties.preferredBatchSizeInKilobytes |
integer |
64 |
慣用的批次大小以 KB 為單位。 |