az eventgrid system-topic event-subscription

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

Команды

az eventgrid system-topic event-subscription create

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

az eventgrid system-topic event-subscription delete

Удаление подписки на события из системного раздела.

az eventgrid system-topic event-subscription list

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

az eventgrid system-topic event-subscription show

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

az eventgrid system-topic event-subscription update

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

az eventgrid system-topic event-subscription create

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

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

Примеры

Создайте новую подписку на события для системного раздела "Сетка событий" с помощью фильтров по умолчанию.

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

Создайте новую подписку на события для системного раздела "Сетка событий" с фильтром, указав префикс темы.

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

Создайте новую подписку на события для системного раздела "Сетка событий", используя фильтры по умолчанию и Клаудевент V 1,0 в качестве схемы доставки.

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

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

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

создайте новую подписку на события для системного раздела "сетка событий", используя в качестве назначения веб-перехватчик Azure Active Directory enabled.

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

Создайте новую подписку на события для системного раздела службы "Сетка событий", используя функцию Azure в качестве назначения.

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

создать новую подписку на события для системного раздела сетки событий, используя служба хранилища очередь в качестве назначения с ttl 5 минут

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

Создание новой подписки на события для системного раздела "Сетка событий" и включение расширенной фильтрации для массивов

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

Обязательные параметры

--name -n

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

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--system-topic-name

Имя системного раздела.

Необязательные параметры

--advanced-filter

Расширенный фильтр включает фильтрацию событий на основе определенного свойства события.

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

Azure Active Directory идентификатор приложения или универсальный код ресурса (Uri) для получения маркера доступа, который будет включаться в качестве токена носителя в запросах на доставку. Применяется только для веб-перехватчика в качестве назначения.

--azure-active-directory-tenant-id

идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включаться в качестве токена носителя в запросах на доставку. Применяется только для веб-перехватчика в качестве назначения.

--deadletter-endpoint

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

--delivery-attribute-mapping

Добавьте сопоставление атрибута доставки для отправки дополнительных сведений через заголовки HTTP при доставке событий. Этот атрибут является допустимым для всех целевых типов, кроме Сторажекуеуе. Несколько атрибутов можно указать с помощью более чем одного --delivery-attribute-mapping аргумента.

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

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

допустимые значения: false, true
--endpoint

Конечная точка, в которой EventGrid должен доставлять события, соответствующие этой подписке на события. Для типа конечной точки веб-перехватчика это должен быть соответствующий 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

Date или DateTime (UTC, например "2018-11-30T11:59:59 + 00:00" или "2018-11-30"), после которого истечет срок действия подписки на событие. По умолчанию срок действия подписки на события отсутствует.

--included-event-types

разделенный пробелами список типов событий (например, Microsoft. служба хранилища. BlobCreated и Microsoft. служба хранилища. BlobDeleted). Чтобы подписываться на все типы событий по умолчанию, не указывайте значение для этого аргумента. Для разделов сетки событий типы событий определяются клиентом. для событий Azure, например служба хранилища учетных записей, центра интернета вещей и т. д., можно запрашивать типы событий с помощью этой команды CLI: az eventgrid topic-type list-event-типы.

--labels

Разделенный пробелами список меток, связываемых с этой подпиской на события.

--max-delivery-attempts

Максимальное число попыток доставки. Должно быть числом от 1 до 30.

значение по умолчанию: 30
--max-events-per-batch

Максимальное количество событий в пакете. Это значение должно быть в диапазоне от 1 до 5000.

--preferred-batch-size-in-kilobytes

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

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

срок жизни сообщения очереди служба хранилища в секундах.

--subject-begins-with

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

--subject-case-sensitive

Укажите, чтобы указать, следует ли сравнивать поля субъекта с учетом регистра. True, если указан флаг.

допустимые значения: false, true
--subject-ends-with

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

--subscription

Имя или идентификатор подписки Вы можете настроить подписку по умолчанию с помощью az account set -s NAME_OR_ID .

az eventgrid system-topic event-subscription delete

Удаление подписки на события из системного раздела.

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

Примеры

Удаление подписки на события для системного раздела "Сетка событий".

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

Обязательные параметры

--name -n

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

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--system-topic-name

Имя системного раздела.

Необязательные параметры

--subscription

Имя или идентификатор подписки Вы можете настроить подписку по умолчанию с помощью az account set -s NAME_OR_ID .

--yes -y

Не запрашивать подтверждение.

az eventgrid system-topic event-subscription list

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

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

Примеры

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

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

Обязательные параметры

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--system-topic-name

Имя системного раздела.

Необязательные параметры

--odata-query

Запрос OData, используемый для фильтрации результатов списка. В настоящее время фильтрация разрешена только для свойства Name. К поддерживаемым операциям относятся: CONTAINS, EQ (для EQUAL), NE (для не равно), AND, OR и NOT.

--query-examples

Рекомендуемая строка JMESPath. Можно скопировать один из запросов и вставить его после параметра--query в двойных кавычках, чтобы увидеть результаты. Можно добавить одно или несколько позиций ключевых слов, чтобы мы могли предоставлять предложения на основе этих ключевых слов.

--subscription

Имя или идентификатор подписки Вы можете настроить подписку по умолчанию с помощью az account set -s NAME_OR_ID .

az eventgrid system-topic event-subscription show

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

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

Примеры

Отображение сведений о подписке на события в системном разделе сетки событий.

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

Отображение сведений о подписке на события для системного раздела "Сетка событий" содержит любые секреты статических атрибутов доставки.

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

Обязательные параметры

--name -n

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

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--system-topic-name

Имя системного раздела.

Необязательные параметры

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

Указывает, должны ли возвращаться какие либо статические секреты атрибута доставки. True, если указан флаг.

допустимые значения: false, true
--include-full-endpoint-url

Укажите, чтобы указать, должен ли быть возвращен полный URL-адрес конечной точки. True, если указан флаг.

допустимые значения: false, true
--query-examples

Рекомендуемая строка JMESPath. Можно скопировать один из запросов и вставить его после параметра--query в двойных кавычках, чтобы увидеть результаты. Можно добавить одно или несколько позиций ключевых слов, чтобы мы могли предоставлять предложения на основе этих ключевых слов.

--subscription

Имя или идентификатор подписки Вы можете настроить подписку по умолчанию с помощью az account set -s NAME_OR_ID .

az eventgrid system-topic event-subscription update

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

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

Примеры

Обновите подписку на события для системного раздела "Сетка событий", чтобы указать новую конечную точку.

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

Обновите подписку на события для системного раздела "Сетка событий", чтобы указать новый фильтр "субъект-конец".

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

Обновите подписку на события для системного раздела "Сетка событий", чтобы указать новую конечную точку и новую тему — с помощью фильтра создать список включаемых типов событий.

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

Обновите подписку на события для системы службы "Сетка событий Azure", чтобы включить недоставленное назначение.

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

Обновление подписки на события для системы службы "Сетка событий Azure" с помощью расширенных фильтров.

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

обновление подписки на события для системного раздела сетки событий с служба хранилища очередью в качестве назначения с ttl 5 минут

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

Обновление подписки на события для системного раздела сетки событий с расширенной фильтрацией по включенным массивам

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

Обязательные параметры

--name -n

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

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--system-topic-name

Имя системного раздела.

Необязательные параметры

--advanced-filter

Расширенный фильтр включает фильтрацию событий на основе определенного свойства события.

--deadletter-endpoint

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

--delivery-attribute-mapping

Добавьте сопоставление атрибута доставки для отправки дополнительных сведений через заголовки HTTP при доставке событий. Этот атрибут является допустимым для всех целевых типов, кроме Сторажекуеуе. Несколько атрибутов можно указать с помощью более чем одного --delivery-attribute-mapping аргумента.

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

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

допустимые значения: false, true
--endpoint

Конечная точка, в которой EventGrid должен доставлять события, соответствующие этой подписке на события. Для типа конечной точки веб-перехватчика это должен быть соответствующий URL-адрес веб-перехватчика. Для других типов конечных точек это должен быть идентификатор ресурса Azure конечной точки. Предполагается, что конечная точка назначения уже создана и доступна для использования перед выполнением любой команды сетки событий.

--endpoint-type

Тип конечной точки назначения.

допустимые значения: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
значение по умолчанию: webhook
--included-event-types

разделенный пробелами список типов событий (например, Microsoft. служба хранилища. BlobCreated и Microsoft. служба хранилища. BlobDeleted). Чтобы подписываться на все типы событий по умолчанию, не указывайте значение для этого аргумента. Для разделов сетки событий типы событий определяются клиентом. для событий Azure, например служба хранилища учетных записей, центра интернета вещей и т. д., можно запрашивать типы событий с помощью этой команды CLI: az eventgrid topic-type list-event-типы.

--labels

Разделенный пробелами список меток, связываемых с этой подпиской на события.

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

срок жизни сообщения очереди служба хранилища в секундах.

--subject-begins-with

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

--subject-ends-with

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

--subscription

Имя или идентификатор подписки Вы можете настроить подписку по умолчанию с помощью az account set -s NAME_OR_ID .