az eventgrid system-topic event-subscription
Gerenciar assinaturas de evento do tópico do sistema.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az eventgrid system-topic event-subscription create |
Crie uma nova assinatura de evento para um tópico do sistema. |
Núcleo | GA |
az eventgrid system-topic event-subscription delete |
Excluir uma assinatura de evento de um tópico do sistema. |
Núcleo | GA |
az eventgrid system-topic event-subscription list |
Listar assinaturas de eventos de um tópico específico do sistema. |
Núcleo | GA |
az eventgrid system-topic event-subscription show |
Obtenha os detalhes de uma assinatura de evento de um tópico do sistema. |
Núcleo | GA |
az eventgrid system-topic event-subscription update |
Atualize uma assinatura de evento de um tópico do sistema. |
Núcleo | GA |
az eventgrid system-topic event-subscription create
Crie uma nova assinatura de evento para um tópico do sistema.
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]
Exemplos
Crie uma nova assinatura de evento para um tópico do sistema da Grade de Eventos usando filtros padrão.
az eventgrid system-topic event-subscription create --name es1 \
-g rg1 --system-topic-name systemtopic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Crie uma nova assinatura de evento para um tópico do sistema da Grade de Eventos, com um filtro especificando um prefixo de assunto.
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
Crie uma nova assinatura de evento para um tópico do sistema da Grade de Eventos, usando filtros padrão e CloudEvent V 1.0 como o esquema de entrega.
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
Crie uma nova assinatura de evento para um tópico do sistema da Grade de Eventos, com um destino morto e uma política de repetição personalizada de no máximo 10 tentativas de entrega e um TTL de evento de 2 horas (o que acontecer anteriormente) e a data de validade.
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"
Crie uma nova assinatura de evento para um tópico do sistema da Grade de Eventos usando o Webhook habilitado para Azure Active Directory como destino.
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
Crie uma nova assinatura de evento para um tópico do sistema da Grade de Eventos usando a Função do Azure como destino.
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
Criar uma nova assinatura de evento para um tópico do sistema da Grade de Eventos usando a Fila de Armazenamento como destino com um ttl de 5 minutos
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
Criar uma nova assinatura de evento para um tópico do sistema da Grade de Eventos e habilitar a filtragem avançada em matrizes
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
Parâmetros Exigidos
Nome da assinatura do evento.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do tópico do sistema.
Parâmetros Opcionais
A ID do Locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável somente para webhook como destino.
Um filtro avançado permite a filtragem de eventos com base em uma propriedade de evento específica.
Uso: --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 Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBegingin --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg 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 NumberNotInRang 100.110 200.210 300.310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --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 Vários filtros avançados podem ser especificados usando mais de um argumento --advanced-filter
.
A ID ou o Uri do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável somente para webhook como destino.
A ID de recurso do Azure de um destino de contêiner de blob do Armazenamento do Azure em que o EventGrid deve remover eventos não entregues para essa assinatura de evento.
Exemplo: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName.
Adicione o mapeamento de atributo de entrega para enviar informações adicionais por meio de cabeçalhos HTTP ao fornecer eventos. Esse atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais de um argumento --delivery-attribute-mapping
.
Uso: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Mapeamento de atributo estático: --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute mapeamento de algum nome estático somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Both Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.
Ponto de extremidade em que o EventGrid deve fornecer eventos correspondentes a esta assinatura de evento. Para o tipo de ponto de extremidade do webhook, essa deve ser a URL de webhook correspondente. Para outros tipos de ponto de extremidade, esse deve ser o identificador de recurso do Azure do ponto de extremidade. Espera-se que o ponto de extremidade de destino já esteja criado e disponível para uso antes de executar qualquer comando da Grade de Eventos.
O tipo do ponto de extremidade de destino.
O esquema no qual os eventos devem ser entregues para esta assinatura de evento. Por padrão, os eventos serão entregues no mesmo esquema no qual são publicados (com base no esquema de entrada do tópico correspondente).
Tempo de vida do evento (em minutos). Deve ser um número entre 1 e 1440.
Data ou datetime (em UTC, por exemplo, '2018-11-30T11:59:59+00:00' ou '2018-11-30') após o qual a assinatura do evento expiraria. Por padrão, não há expiração para a assinatura do evento.
Uma lista separada por espaço de tipos de eventos (por exemplo, Microsoft.Storage.BlobCreated e Microsoft.Storage.BlobDeleted). Para assinar todos os tipos de evento padrão, não especifique nenhum valor para esse argumento. Para tópicos da grade de eventos, os tipos de evento são definidos pelo cliente. Para eventos do Azure, por exemplo, Contas de Armazenamento, Hub IoT etc., você pode consultar seus tipos de eventos usando este comando da CLI 'az eventgrid topic-type list-event-types'.
Uma lista separada por espaço de rótulos a serem associados a essa assinatura de evento.
Número máximo de tentativas de entrega. Deve ser um número entre 1 e 30.
Número máximo de eventos em um lote. Deve ser um número entre 1 e 5000.
Tamanho de lote preferencial em quilobytes. Deve ser um número entre 1 e 1024.
Tempo de vida da mensagem da fila de armazenamento em segundos.
Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo. Não há suporte para caracteres curinga.
Especifique para indicar se os campos de assunto devem ser comparados de maneira sensível a maiúsculas de minúsculas. True se o sinalizador estiver presente.
Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo. Não há suporte para caracteres curinga.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az eventgrid system-topic event-subscription delete
Excluir uma assinatura de evento de um tópico do sistema.
az eventgrid system-topic event-subscription delete --name
--resource-group
--system-topic-name
[--yes]
Exemplos
Exclua uma assinatura de evento para um tópico do sistema da Grade de Eventos.
az eventgrid system-topic event-subscription delete --name es1 \
-g rg1 --system-topic-name systemtopic1 \
Parâmetros Exigidos
Nome da assinatura do evento.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do tópico do sistema.
Parâmetros Opcionais
Não solicite confirmação.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az eventgrid system-topic event-subscription list
Listar assinaturas de eventos de um tópico específico do sistema.
az eventgrid system-topic event-subscription list --resource-group
--system-topic-name
[--odata-query]
Exemplos
Liste todas as assinaturas de evento criadas para um tópico do sistema da Grade de Eventos.
az eventgrid system-topic event-subscription list -g rg1 --system-topic-name systemtopic1
Parâmetros Exigidos
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do tópico do sistema.
Parâmetros Opcionais
A consulta OData usada para filtrar os resultados da lista. Atualmente, a filtragem é permitida apenas na propriedade Name. As operações com suporte incluem: CONTAINS, eq (para igual), ne (para não igual), AND, OR e NOT.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az eventgrid system-topic event-subscription show
Obtenha os detalhes de uma assinatura de evento de um tópico do sistema.
az eventgrid system-topic event-subscription show --name
--resource-group
--system-topic-name
[--include-attrib-secret {false, true}]
[--include-full-endpoint-url {false, true}]
Exemplos
Mostrar os detalhes de uma assinatura de evento para um tópico do sistema da Grade de Eventos.
az eventgrid system-topic event-subscription show --name es1 \
-g rg1 --system-topic-name systemtopic1
Mostrar os detalhes de uma assinatura de evento para um tópico do sistema da Grade de Eventos inclui todos os segredos de atributo de entrega estático.
az eventgrid system-topic event-subscription show --name es1 \
-g rg1 --system-topic-name systemtopic1 --include-attrib-secret
Parâmetros Exigidos
Nome da assinatura do evento.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do tópico do sistema.
Parâmetros Opcionais
Indique se algum segredo de atributo de entrega estático deve ser retornado. True se o sinalizador estiver presente.
Especifique para indicar se a URL do ponto de extremidade completo deve ser retornada. True se o sinalizador estiver presente.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
az eventgrid system-topic event-subscription update
Atualize uma assinatura de evento de um tópico do sistema.
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]
Exemplos
Atualize uma assinatura de evento para um tópico do sistema da Grade de Eventos para especificar um novo ponto de extremidade.
az eventgrid system-topic event-subscription update --name es1 \
-g rg1 --system-topic-name systemtopic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code
Atualize uma assinatura de evento para um tópico do sistema da Grade de Eventos para especificar um novo assunto com filtro.
az eventgrid system-topic event-subscription update --name es2 \
-g rg1 --system-topic-name systemtopic1 \
--subject-ends-with .jpg
Atualize uma assinatura de evento para um tópico do sistema da Grade de Eventos para especificar um novo ponto de extremidade e um novo assunto-termina com filtrar uma nova lista de tipos de eventos incluídos.
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
Atualize uma assinatura de evento para um tópico do sistema da Grade de Eventos do Azure para incluir um destino morto.
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
Atualize uma assinatura de evento para um tópico do sistema da Grade de Eventos do Azure usando filtros avançados.
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
Atualizar uma assinatura de evento para um tópico do sistema da Grade de Eventos com a Fila de Armazenamento como destino com ttl de 5 minutos
az eventgrid system-topic event-subscription update -n es1 \
-g rg1 --system-topic-name systemtopic1 \
--storage-queue-msg-ttl 300
Atualizar uma assinatura de evento para um tópico do sistema da Grade de Eventos com filtragem avançada em matrizes habilitadas
az eventgrid system-topic event-subscription update -n es1 \
-g rg1 --system-topic-name systemtopic1 \
--enable-advanced-filtering-on-arrays true
Parâmetros Exigidos
Nome da assinatura do evento.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome do tópico do sistema.
Parâmetros Opcionais
Um filtro avançado permite a filtragem de eventos com base em uma propriedade de evento específica.
Uso: --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 Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBegingin --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png jpg 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 NumberNotInRang 100.110 200.210 300.310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --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 Vários filtros avançados podem ser especificados usando mais de um argumento --advanced-filter
.
A ID de recurso do Azure de um destino de contêiner de blob do Armazenamento do Azure em que o EventGrid deve remover eventos não entregues para essa assinatura de evento.
Adicione o mapeamento de atributo de entrega para enviar informações adicionais por meio de cabeçalhos HTTP ao fornecer eventos. Esse atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais de um argumento --delivery-attribute-mapping
.
Uso: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Mapeamento de atributo estático: --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute mapeamento de algum nome estático somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Both Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.
Ponto de extremidade em que o EventGrid deve fornecer eventos correspondentes a esta assinatura de evento. Para o tipo de ponto de extremidade do webhook, essa deve ser a URL de webhook correspondente. Para outros tipos de ponto de extremidade, esse deve ser o identificador de recurso do Azure do ponto de extremidade. Espera-se que o ponto de extremidade de destino já esteja criado e disponível para uso antes de executar qualquer comando da Grade de Eventos.
O tipo do ponto de extremidade de destino.
Uma lista separada por espaço de tipos de eventos (por exemplo, Microsoft.Storage.BlobCreated e Microsoft.Storage.BlobDeleted). Para assinar todos os tipos de evento padrão, não especifique nenhum valor para esse argumento. Para tópicos da grade de eventos, os tipos de evento são definidos pelo cliente. Para eventos do Azure, por exemplo, Contas de Armazenamento, Hub IoT etc., você pode consultar seus tipos de eventos usando este comando da CLI 'az eventgrid topic-type list-event-types'.
Uma lista separada por espaço de rótulos a serem associados a essa assinatura de evento.
Tempo de vida da mensagem da fila de armazenamento em segundos.
Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo. Não há suporte para caracteres curinga.
Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo. Não há suporte para caracteres curinga.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
Mostre esta mensagem de ajuda e saia.
Apenas mostrar erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.