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
[--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 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
Создайте новую подписку на события для системного раздела Сетки событий, используя фильтры по умолчанию и CloudEvent 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 в качестве назначения.
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
Обязательные параметры
Имя подписки на событие.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя системного раздела.
Необязательные параметры
Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. Применимо только для веб-перехватчика в качестве назначения.
Расширенный фильтр позволяет фильтровать события на основе определенного свойства события.
Использование: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --advanced-filter data. Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter data. Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue 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 png numberIn: --advanced-filter data.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 NumberNotNotInRange 100,110 200 210 300 310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThanThan: --advanced-filter data.property3 NumberGreaterThan 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 Multiple advanced filter можно указать с помощью нескольких --advanced-filter
аргумента.
Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. Применимо только для веб-перехватчика в качестве назначения.
Идентификатор ресурса Azure для назначения контейнера BLOB-объектов службы хранилища Azure, в котором EventGrid должна быть недоставленной событиями для этой подписки на событие.
Пример: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containerName.
Добавьте сопоставление атрибутов доставки для отправки дополнительных сведений через заголовки HTTP при доставке событий. Этот атрибут действителен для всех типов назначения, кроме StorageQueue. Несколько атрибутов можно указать с помощью нескольких --delivery-attribute-mapping
аргументов.
Использование: --delivery-attribute-mapping атрибут-name атрибут-type атрибут-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 true Dynamic Attribute Mapping: --delivery-attribute-mapping: --delivery-attribute-mapping somename-mapping somename dynamic somevalue Both Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения.
Конечная точка, в которой EventGrid должна доставлять события, соответствующие этой подписке на события. Для типа конечной точки веб-перехватчика это должен быть соответствующий URL-адрес веб-перехватчика. Для других типов конечных точек это должен быть идентификатор ресурса Azure конечной точки. Ожидается, что конечная точка назначения уже создана и доступна для использования перед выполнением любой команды Сетки событий.
Тип конечной точки назначения.
Схема, в которой должны быть доставлены события для этой подписки на события. По умолчанию события будут доставлены в той же схеме, в которой они публикуются (на основе входной схемы соответствующего раздела).
Время жизни события (в минутах). Должно быть число от 1 до 1440.
Дата или дата (в формате UTC, например "2018-11-30T11:59:59+00:00" или "2018-11-30"), после чего срок действия подписки на событие истекает. По умолчанию срок действия подписки на события отсутствует.
Разделенный пробелом список типов событий (например, Microsoft.Storage.BlobCreated и Microsoft.Storage.BlobDeleted). Чтобы подписаться на все типы событий по умолчанию, не указывайте значение для этого аргумента. Для разделов сетки событий типы событий определяются клиентом. Для событий Azure, например учетных записей хранения, Центра Интернета вещей и т. д., можно запрашивать их типы событий с помощью этой команды CLI "az eventgrid topic-type list-event-types".
Разделенный пробелом список меток для связывания с этой подпиской на событие.
Максимальное количество попыток доставки. Должно быть число от 1 до 30.
Максимальное количество событий в пакете. Должно быть число от 1 до 5000.
Предпочтительный размер пакета в килобайтах. Должно быть числом от 1 до 1024.
Время ожидания сообщения очереди хранилища в секундах.
Необязательная строка для фильтрации событий для подписки на события на основе префикса. Подстановочные знаки не поддерживаются.
Укажите, следует ли сравнивать поля субъекта с учетом регистра. Значение True, если флаг присутствует.
Необязательная строка для фильтрации событий для подписки на события на основе суффикса. Подстановочные знаки не поддерживаются.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az eventgrid system-topic event-subscription delete
Удаление подписки на событие системного раздела.
az eventgrid system-topic event-subscription delete --name
--resource-group
--system-topic-name
[--yes]
Примеры
Удаление подписки на событие для системного раздела Сетки событий.
az eventgrid system-topic event-subscription delete --name es1 \
-g rg1 --system-topic-name systemtopic1 \
Обязательные параметры
Имя подписки на событие.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя системного раздела.
Необязательные параметры
Не запрашивайте подтверждение.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
az eventgrid system-topic event-subscription list
Вывод списка подписок на события определенного системного раздела.
az eventgrid system-topic event-subscription list --resource-group
--system-topic-name
[--odata-query]
Примеры
Список всех подписок на события, созданных для системного раздела сетки событий.
az eventgrid system-topic event-subscription list -g rg1 --system-topic-name systemtopic1
Обязательные параметры
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя системного раздела.
Необязательные параметры
Запрос OData, используемый для фильтрации результатов списка. Фильтрация в настоящее время разрешена только в свойстве Name. Поддерживаемые операции включают: CONTAINS, eq (for equal), ne (for not equal), AND, OR и NOT.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
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}]
Примеры
Отображение сведений о подписке на события для системного раздела сетки событий.
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
Обязательные параметры
Имя подписки на событие.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя системного раздела.
Необязательные параметры
Укажите, следует ли возвращать какие-либо секреты атрибута статической доставки. Значение True, если флаг присутствует.
Укажите, следует ли возвращать полный URL-адрес конечной точки. Значение True, если флаг присутствует.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.
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]
Примеры
Обновите подписку на события для системного раздела сетки событий, чтобы указать новую конечную точку.
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
Обязательные параметры
Имя подписки на событие.
Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя системного раздела.
Необязательные параметры
Расширенный фильтр позволяет фильтровать события на основе определенного свойства события.
Использование: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --advanced-filter data. Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter data. Color StringNotIn Blue Red Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue 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 png numberIn: --advanced-filter data.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 NumberNotNotInRange 100,110 200 210 300 310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThanThan: --advanced-filter data.property3 NumberGreaterThan 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 Multiple advanced filter можно указать с помощью нескольких --advanced-filter
аргумента.
Идентификатор ресурса Azure для назначения контейнера BLOB-объектов службы хранилища Azure, в котором EventGrid должна быть недоставленной событиями для этой подписки на событие.
Добавьте сопоставление атрибутов доставки для отправки дополнительных сведений через заголовки HTTP при доставке событий. Этот атрибут действителен для всех типов назначения, кроме StorageQueue. Несколько атрибутов можно указать с помощью нескольких --delivery-attribute-mapping
аргументов.
Использование: --delivery-attribute-mapping атрибут-name атрибут-type атрибут-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 true Dynamic Attribute Mapping: --delivery-attribute-mapping: --delivery-attribute-mapping somename-mapping somename dynamic somevalue Both Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения.
Конечная точка, в которой EventGrid должна доставлять события, соответствующие этой подписке на события. Для типа конечной точки веб-перехватчика это должен быть соответствующий URL-адрес веб-перехватчика. Для других типов конечных точек это должен быть идентификатор ресурса Azure конечной точки. Ожидается, что конечная точка назначения уже создана и доступна для использования перед выполнением любой команды Сетки событий.
Тип конечной точки назначения.
Разделенный пробелом список типов событий (например, Microsoft.Storage.BlobCreated и Microsoft.Storage.BlobDeleted). Чтобы подписаться на все типы событий по умолчанию, не указывайте значение для этого аргумента. Для разделов сетки событий типы событий определяются клиентом. Для событий Azure, например учетных записей хранения, Центра Интернета вещей и т. д., можно запрашивать их типы событий с помощью этой команды CLI "az eventgrid topic-type list-event-types".
Разделенный пробелом список меток для связывания с этой подпиской на событие.
Время ожидания сообщения очереди хранилища в секундах.
Необязательная строка для фильтрации событий для подписки на события на основе префикса. Подстановочные знаки не поддерживаются.
Необязательная строка для фильтрации событий для подписки на события на основе суффикса. Подстановочные знаки не поддерживаются.
Глобальные параметры
Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.
Отображение этого сообщения справки и выхода.
Отображаются только ошибки, подавляющие предупреждения.
Формат вывода.
Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.