Поделиться через

Event Subscriptions - Get

  • Ссылка
Служба:
Event Grid
Версия API:
2025-02-15

Получение подписки на события.
Получение свойств подписки на событие.

GET https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}?api-version=2025-02-15

Параметры URI

Имя В Обязательно Тип Описание
eventSubscriptionName
 path True

string

Имя найденной подписки на событие.
scope
 path True

string

Область действия подписки на события. Область может быть подпиской, группой ресурсов или ресурсом верхнего уровня, принадлежащим к пространству имен поставщика ресурсов, или разделу EventGrid. Например, используйте "/subscriptions/{subscriptionId}/" для подписки, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для группы ресурсов, и "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" для ресурса и "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}" для раздела EventGrid.
api-version
 query True

string

Версия API для использования с клиентским запросом.

Ответы

Имя Тип Описание
200 OK

EventSubscription

ХОРОШО
Other Status Codes

Ответы на ошибки: ***

  • 400 Недопустимый запрос.

  • Ошибка внутреннего сервера 500.

Примеры

EventSubscriptions_GetForCustomTopic
EventSubscriptions_GetForCustomTopic_AzureFunctionDestination
EventSubscriptions_GetForCustomTopic_EventHubDestination
EventSubscriptions_GetForCustomTopic_HybridConnectionDestination
EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination
EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination
EventSubscriptions_GetForCustomTopic_StorageQueueDestination
EventSubscriptions_GetForCustomTopic_WebhookDestination
EventSubscriptions_GetForResource
EventSubscriptions_GetForResourceGroup
EventSubscriptions_GetForSubscription

EventSubscriptions_GetForCustomTopic

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_AzureFunctionDestination

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      },
      "endpointType": "AzureFunction"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_EventHubDestination

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_HybridConnectionDestination

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      },
      "endpointType": "HybridConnection"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_ServiceBusQueueDestination

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      },
      "endpointType": "ServiceBusQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_ServiceBusTopicDestination

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      },
      "endpointType": "ServiceBusTopic"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_StorageQueueDestination

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1",
        "queueMessageTimeToLiveInSeconds": 300
      },
      "endpointType": "StorageQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForCustomTopic_WebhookDestination

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForResource

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForResourceGroup

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
  "name": "examplesubscription2",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_GetForSubscription

Образец запроса

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3?api-version=2025-02-15

Пример ответа

Код состояния:
200 
{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": [
      "label1",
      "label2"
    ],
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
  "name": "examplesubscription3",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

Определения

Имя Описание
AzureFunctionEventSubscriptionDestination

Сведения о назначении функции Azure для подписки на события.
BoolEqualsAdvancedFilter

Расширенный фильтр BoolEquals.
createdByType

Тип удостоверения, создавшего ресурс.
DeadLetterWithResourceIdentity

Сведения о назначении недоставки с удостоверением ресурса.
DeliveryWithResourceIdentity

Сведения о доставке подписки на события с удостоверением ресурса.
DynamicDeliveryAttributeMapping

Сведения о сопоставлении атрибутов динамической доставки.
EventDeliverySchema

Схема доставки событий для подписки на события.
EventHubEventSubscriptionDestination

Сведения о назначении концентратора событий для подписки на события.
EventSubscription

Подписка на события.
EventSubscriptionFilter

Фильтр для подписки на события.
EventSubscriptionIdentity

Сведения об удостоверениях с подпиской на событие.
EventSubscriptionIdentityType

Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned.
EventSubscriptionProvisioningState

Состояние подготовки подписки на событие.
HybridConnectionEventSubscriptionDestination

Сведения о назначении HybridConnection для подписки на события.
IsNotNullAdvancedFilter

Расширенный фильтр IsNotNull.
IsNullOrUndefinedAdvancedFilter

Расширенный фильтр IsNullOrUndefined.
MonitorAlertEventSubscriptionDestination

Сведения о назначении оповещения монитора для подписки на события.
MonitorAlertSeverity

Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события. Это поле должно быть предоставлено.
NamespaceTopicEventSubscriptionDestination

Сведения о назначении раздела пространства имен для подписки на события.
NumberGreaterThanAdvancedFilter

Расширенный фильтр NumberGreaterThan.
NumberGreaterThanOrEqualsAdvancedFilter

Advanced Filter NumberGreaterThanOrEquals.
NumberInAdvancedFilter

Расширенный фильтр NumberIn.
NumberInRangeAdvancedFilter

Расширенный фильтр NumberInRange.
NumberLessThanAdvancedFilter

Расширенный фильтр NumberLessThan.
NumberLessThanOrEqualsAdvancedFilter

Расширенный фильтр NumberLessThanOrEquals.
NumberNotInAdvancedFilter

Расширенный фильтр NumberNotIn.
NumberNotInRangeAdvancedFilter

Расширенный фильтр NumberNotInRange.
RetryPolicy

Сведения о политике повторных попыток для подписки на события.
ServiceBusQueueEventSubscriptionDestination

Сведения о назначении служебной шины для подписки на события.
ServiceBusTopicEventSubscriptionDestination

Сведения о назначении раздела служебной шины для подписки на событие.
StaticDeliveryAttributeMapping

Сведения о сопоставлении атрибутов статической доставки.
StorageBlobDeadLetterDestination

Сведения о назначении недоставленных сообщений на основе BLOB-объектов хранилища.
StorageQueueEventSubscriptionDestination

Сведения о назначении очереди хранилища для подписки на события.
StringBeginsWithAdvancedFilter

Расширенный фильтр StringBeginsWith.
StringContainsAdvancedFilter

Расширенный фильтр StringContains.
StringEndsWithAdvancedFilter

Расширенный фильтр StringEndsWith.
StringInAdvancedFilter

Расширенный фильтр StringIn.
StringNotBeginsWithAdvancedFilter

Расширенный фильтр StringNotBeginsWith.
StringNotContainsAdvancedFilter

Расширенный фильтр StringNotContains.
StringNotEndsWithAdvancedFilter

Расширенный фильтр StringNotEndsWith.
StringNotInAdvancedFilter

Расширенный фильтр StringNotIn.
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
TlsVersion

Минимальная версия TLS издателя, разрешенная для публикации в этом домене
WebHookEventSubscriptionDestination

Сведения о назначении веб-перехватчика для подписки на события.

AzureFunctionEventSubscriptionDestination

Сведения о назначении функции Azure для подписки на события.

Имя Тип Default value Описание
endpointType string:

AzureFunction

Тип конечной точки для назначения подписки на события.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Сведения о атрибуте доставки.
properties.maxEventsPerBatch

integer

1

Максимальное количество событий в пакете.
properties.preferredBatchSizeInKilobytes

integer

64

Предпочтительный размер пакета в Килобайтах.
properties.resourceId

string

Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на событие.

BoolEqualsAdvancedFilter

Расширенный фильтр BoolEquals.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

BoolEquals

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
value

boolean

Логическое значение фильтра.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

DeadLetterWithResourceIdentity

Сведения о назначении недоставки с удостоверением ресурса.

Имя Тип Описание
deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время недоставки.
identity

EventSubscriptionIdentity

Удостоверение, используемое при недоставленных событиях.

DeliveryWithResourceIdentity

Сведения о доставке подписки на события с удостоверением ресурса.

Имя Тип Описание
destination EventSubscriptionDestination:

Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки.
identity

EventSubscriptionIdentity

Удостоверение, используемое при доставке событий.

DynamicDeliveryAttributeMapping

Сведения о сопоставлении атрибутов динамической доставки.

Имя Тип Описание
name

string

Имя атрибута доставки или заголовка.
properties.sourceField

string

Путь JSON в событии, которое содержит значение атрибута.
type string:

Dynamic

Тип атрибута доставки или имени заголовка.

EventDeliverySchema

Схема доставки событий для подписки на события.

Имя Тип Описание
CloudEventSchemaV1_0

string

CustomInputSchema

string

EventGridSchema

string

EventHubEventSubscriptionDestination

Сведения о назначении концентратора событий для подписки на события.

Имя Тип Описание
endpointType string:

EventHub

Тип конечной точки для назначения подписки на события.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Сведения о атрибуте доставки.
properties.resourceId

string

Идентификатор ресурса Azure, представляющий конечную точку назначения Концентратора событий подписки на событие.

EventSubscription

Подписка на события.

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса.
name

string

Имя ресурса.
properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки.
properties.deadLetterWithResourceIdentity

DeadLetterWithResourceIdentity

Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки.
properties.deliveryWithResourceIdentity

DeliveryWithResourceIdentity

Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки.
properties.destination EventSubscriptionDestination:

Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки.
properties.eventDeliverySchema

EventDeliverySchema

EventGridSchema

Схема доставки событий для подписки на события.
properties.expirationTimeUtc

string

Срок действия подписки на событие.
properties.filter

EventSubscriptionFilter

Сведения о фильтре для подписки на события.
properties.labels

string[]

Список определяемых пользователем меток.
properties.provisioningState

EventSubscriptionProvisioningState

Состояние подготовки подписки на событие.
properties.retryPolicy

RetryPolicy

Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий.
properties.topic

string

Имя темы подписки на событие.
systemData

systemData

Системные метаданные, относящиеся к ресурсу Сетки событий.
type

string

Тип ресурса.

EventSubscriptionFilter

Фильтр для подписки на события.

Имя Тип Default value Описание
advancedFilters AdvancedFilter[]:

Массив расширенных фильтров, используемых для фильтрации подписок на события.
enableAdvancedFilteringOnArrays

boolean

Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения.
includedEventTypes

string[]

Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL.
isSubjectCaseSensitive

boolean

False

Указывает, должны ли свойства SubjectBeginsWith и SubjectEndsWith фильтра сравниваться с учетом регистра.
subjectBeginsWith

string

Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу. Формат этого зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути.
subjectEndsWith

string

Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути.

EventSubscriptionIdentity

Сведения об удостоверениях с подпиской на событие.

Имя Тип Описание
type

EventSubscriptionIdentityType

Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned.
userAssignedIdentity

string

Удостоверение пользователя, связанное с ресурсом.

EventSubscriptionIdentityType

Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned.

Имя Тип Описание
SystemAssigned

string

UserAssigned

string

EventSubscriptionProvisioningState

Состояние подготовки подписки на событие.

Имя Тип Описание
AwaitingManualAction

string

Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

HybridConnectionEventSubscriptionDestination

Сведения о назначении HybridConnection для подписки на события.

Имя Тип Описание
endpointType string:

HybridConnection

Тип конечной точки для назначения подписки на события.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Сведения о атрибуте доставки.
properties.resourceId

string

Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события.

IsNotNullAdvancedFilter

Расширенный фильтр IsNotNull.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

IsNotNull

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.

IsNullOrUndefinedAdvancedFilter

Расширенный фильтр IsNullOrUndefined.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

IsNullOrUndefined

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.

MonitorAlertEventSubscriptionDestination

Сведения о назначении оповещения монитора для подписки на события.

Имя Тип Описание
endpointType string:

MonitorAlert

Тип конечной точки для назначения подписки на события.
properties.actionGroups

string[]

Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном с помощью этой подписки на событие. Каждый идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
properties.description

string

Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие.
properties.severity

MonitorAlertSeverity

Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события. Это поле должно быть предоставлено.

MonitorAlertSeverity

Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события. Это поле должно быть предоставлено.

Имя Тип Описание
Sev0

string

Sev1

string

Sev2

string

Sev3

string

Sev4

string

NamespaceTopicEventSubscriptionDestination

Сведения о назначении раздела пространства имен для подписки на события.

Имя Тип Описание
endpointType string:

NamespaceTopic

Тип конечной точки для назначения подписки на события.
properties.resourceId

string

Идентификатор ресурса Azure, представляющий конечную точку назначения пространства имен сетки событий подписки на событие. Это поле необходимо, и ресурс раздела пространства имен уже должен существовать. Идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topic/{TopicName}.

NumberGreaterThanAdvancedFilter

Расширенный фильтр NumberGreaterThan.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberGreaterThan

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
value

number

Значение фильтра.

NumberGreaterThanOrEqualsAdvancedFilter

Advanced Filter NumberGreaterThanOrEquals.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberGreaterThanOrEquals

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
value

number

Значение фильтра.

NumberInAdvancedFilter

Расширенный фильтр NumberIn.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberIn

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

number[]

Набор значений фильтра.

NumberInRangeAdvancedFilter

Расширенный фильтр NumberInRange.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberInRange

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

number[]

Набор значений фильтра.

NumberLessThanAdvancedFilter

Расширенный фильтр NumberLessThan.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberLessThan

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
value

number

Значение фильтра.

NumberLessThanOrEqualsAdvancedFilter

Расширенный фильтр NumberLessThanOrEquals.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberLessThanOrEquals

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
value

number

Значение фильтра.

NumberNotInAdvancedFilter

Расширенный фильтр NumberNotIn.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberNotIn

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

number[]

Набор значений фильтра.

NumberNotInRangeAdvancedFilter

Расширенный фильтр NumberNotInRange.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

NumberNotInRange

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

number[]

Набор значений фильтра.

RetryPolicy

Сведения о политике повторных попыток для подписки на события.

Имя Тип Default value Описание
eventTimeToLiveInMinutes

integer

1440

Время жизни (в минутах) для событий.
maxDeliveryAttempts

integer

30

Максимальное количество попыток повторных попыток доставки для событий.

ServiceBusQueueEventSubscriptionDestination

Сведения о назначении служебной шины для подписки на события.

Имя Тип Описание
endpointType string:

ServiceBusQueue

Тип конечной точки для назначения подписки на события.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Сведения о атрибуте доставки.
properties.resourceId

string

Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на событие.

ServiceBusTopicEventSubscriptionDestination

Сведения о назначении раздела служебной шины для подписки на событие.

Имя Тип Описание
endpointType string:

ServiceBusTopic

Тип конечной точки для назначения подписки на события.
properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

Сведения о атрибуте доставки.
properties.resourceId

string

Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на событие.

StaticDeliveryAttributeMapping

Сведения о сопоставлении атрибутов статической доставки.

Имя Тип Default value Описание
name

string

Имя атрибута доставки или заголовка.
properties.isSecret

boolean

False

Логический флаг, чтобы определить, содержит ли атрибут конфиденциальную информацию.
properties.value

string

Значение атрибута доставки.
type string:

Static

Тип атрибута доставки или имени заголовка.

StorageBlobDeadLetterDestination

Сведения о назначении недоставленных сообщений на основе BLOB-объектов хранилища.

Имя Тип Описание
endpointType string:

StorageBlob

Тип конечной точки для назначения недоставленной буквы
properties.blobContainerName

string

Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки
properties.resourceId

string

Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки

StorageQueueEventSubscriptionDestination

Сведения о назначении очереди хранилища для подписки на события.

Имя Тип Описание
endpointType string:

StorageQueue

Тип конечной точки для назначения подписки на события.
properties.queueMessageTimeToLiveInSeconds

integer

Время ожидания сообщения очереди хранилища в секундах. Это значение не может быть нулевым или отрицательным, за исключением использования -1, чтобы указать, что время жизни сообщения бесконечно.
properties.queueName

string

Имя очереди хранилища в учетной записи хранения, которая является назначением подписки на событие.
properties.resourceId

string

Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является назначением подписки на событие.

StringBeginsWithAdvancedFilter

Расширенный фильтр StringBeginsWith.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringBeginsWith

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

StringContainsAdvancedFilter

Расширенный фильтр StringContains.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringContains

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

StringEndsWithAdvancedFilter

Расширенный фильтр StringEndsWith.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringEndsWith

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

StringInAdvancedFilter

Расширенный фильтр StringIn.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringIn

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

StringNotBeginsWithAdvancedFilter

Расширенный фильтр StringNotBeginsWith.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringNotBeginsWith

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

StringNotContainsAdvancedFilter

Расширенный фильтр StringNotContains.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringNotContains

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

StringNotEndsWithAdvancedFilter

Расширенный фильтр StringNotEndsWith.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringNotEndsWith

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

StringNotInAdvancedFilter

Расширенный фильтр StringNotIn.

Имя Тип Описание
key

string

Поле или свойство в событии, на основе которого требуется отфильтровать.
operatorType string:

StringNotIn

Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других.
values

string[]

Набор значений фильтра.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

TlsVersion

Минимальная версия TLS издателя, разрешенная для публикации в этом домене

Имя Тип Описание
1.0

string

1.1

string

1.2

string

WebHookEventSubscriptionDestination

Сведения о назначении веб-перехватчика для подписки на события.

Имя Тип Default value Описание
endpointType string:

WebHook

Тип конечной точки для назначения подписки на события.
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.minimumTlsVersionAllowed

TlsVersion

Минимальная версия TLS, которая должна поддерживаться конечной точкой веб-перехватчика
properties.preferredBatchSizeInKilobytes

integer

64

Предпочтительный размер пакета в Килобайтах.