az eventgrid topic event-subscription

Gerir subscrições de eventos de tópico.

Comandos

az eventgrid topic event-subscription create

Crie uma nova subscrição de eventos para um tópico.

az eventgrid topic event-subscription delete

Elimine uma subscrição de evento de um tópico.

az eventgrid topic event-subscription list

Listar subscrições de eventos de um tópico específico.

az eventgrid topic event-subscription show

Obtenha os detalhes de uma subscrição de evento de um tópico.

az eventgrid topic event-subscription update

Atualizar uma subscrição de evento de um tópico.

az eventgrid topic event-subscription create

Crie uma nova subscrição de eventos para um tópico.

az eventgrid topic event-subscription create --name
                                             --resource-group
                                             --topic-name
                                             [--aad-app-id]
                                             [--aad-tenant-id]
                                             [--advanced-filter]
                                             [--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]
                                             [--pref-batch-size-kb]
                                             [--qttl]
                                             [--subject-begins-with]
                                             [--subject-case-sensitive {false, true}]
                                             [--subject-ends-with]

Exemplos

Crie uma nova subscrição de eventos para um tópico de Grade de Eventos, utilizando filtros predefinidos.

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

Crie uma nova subscrição de eventos para um tópico de Grade de Eventos, com um filtro especificando um prefixo do assunto.

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

Crie uma nova subscrição de eventos para um tópico de Grade de Eventos, utilizando filtros predefinidos, e CloudEvent V 1.0 como o esquema de entrega.

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

Crie uma nova subscrição de eventos para um tópico de Grade de Eventos, com um destino deadletter e política de relemisão personalizada de máximos de 10 tentativas de entrega e um Evento TTL de 2 horas (o que acontecer anteriormente) e data de validade.

az eventgrid topic event-subscription create --name es2 \
    -g rg1 --topic-name topic1 \
    --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 subscrição de eventos para um tópico de Grade de Eventos, utilizando o Azure Ative Directory habilitado webhook como destino.

az eventgrid topic event-subscription create --name es1 \
    -g rg1 --topic-name topic1 \
    --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 subscrição de eventos para um tópico de Grade de Eventos, utilizando a Função Azure como destino.

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

Crie uma nova subscrição de eventos para um tópico de Grade de Eventos usando a Fila de Armazenamento como destino com um ttl de 5 minutos

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

Crie uma nova subscrição de eventos para um tópico de Grade de Eventos e permita a filtragem avançada em matrizes

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

Parâmetros Obrigatórios

--name -n

Nome da subscrição do evento.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--topic-name

O nome do tópico.

Parâmetros Opcionais

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

O Azure Ative Directory Application Id ou Uri para obter o token de acesso que será incluído como símbolo portador nos pedidos de entrega. Aplicável apenas para webhook como um destino.

--aad-tenant-id --azure-active-directory-tenant-id

O Azure Ative Directory Tenanty Id para obter o token de acesso que será incluído como símbolo portador nos pedidos de entrega. Aplicável apenas para webhook como um destino.

--advanced-filter

Um filtro avançado permite a filtragem de eventos com base numa propriedade específica do evento.

--deadletter-endpoint

O ID de recurso Azure de um destino de contentores de blob de armazenamento Azure onde o EventGrid deve matar eventos não entregues para esta subscrição do evento.

--delivery-attribute-mapping -d

Adicione o mapeamento do atributo de entrega para enviar informações adicionais através de cabeçalhos HTTP ao entregar eventos. Este atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais do que um --delivery-attribute-mapping argumento.

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

Permite que filtros avançados sejam avaliados contra uma matriz de valores em vez de esperar um valor singular.

valores aceites: false, true
--endpoint

Ponto final onde o EventGrid deve entregar eventos correspondentes a esta subscrição do evento. Para o tipo de ponto final webhook, este deve ser o URL webhook correspondente. Para outros tipos de pontos finais, este deve ser o identificador de recursos Azure do ponto final. Espera-se que o ponto final do destino já esteja criado e disponível para utilização antes de executar qualquer comando da Grade de Eventos.

--endpoint-type

O tipo de destino ponto final.

valores aceites: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
valor predefinido: webhook
--event-delivery-schema

O esquema em que os eventos devem ser entregues para esta subscrição do evento. Por padrão, os eventos serão entregues no mesmo esquema em que são publicados (com base no esquema de entrada do tópico correspondente).

valores aceites: cloudeventschemav1_0, custominputschema, eventgridschema
--event-ttl

Hora do evento para viver (em minutos). Deve haver um número entre 1 e 1440.

valor predefinido: 1440
--expiration-date

Data ou data (na UTC, por exemplo , '2018-11-30T11:59:59+00:00' ou '2018-11-30') após o qual a subscrição do evento expiraria. Por padrão, não existe caducidade para a subscrição do evento.

--included-event-types

Uma lista de tipos de eventos separada pelo espaço (por exemplo, Microsoft.Storage.BlobCreated e Microsoft.Storage.BlobDeleted). Para subscrever todos os tipos de eventos predefinidos, não especifique qualquer valor para este argumento. Para tópicos de grelha de eventos, os tipos de eventos são definidos pelo cliente. Para eventos Azure, por exemplo, Contas de Armazenamento, Hub IoT, etc., pode consultar os seus tipos de eventos utilizando este comando CLI 'az eventgrid tipo de lista-tipos de eventos'.

--labels

Uma lista de etiquetas separadas pelo espaço para associar a esta subscrição do evento.

--max-delivery-attempts

Número máximo de tentativas de entrega. Deve haver um número entre 1 e 30.

valor predefinido: 30
--max-events-per-batch

Número máximo de eventos num lote. Deve ser um número entre 1 e 5000.

--pref-batch-size-kb --preferred-batch-size-in-kilobytes

Tamanho do lote preferido em quilobytes. Deve haver um número entre 1 e 1024.

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

Tempo de mensagem de fila de armazenamento para viver em segundos.

--subject-begins-with

Uma cadeia opcional para filtrar eventos para uma subscrição de eventos com base num prefixo. Os caracteres wildcard não são suportados.

--subject-case-sensitive

Especificar para indicar se os campos sujeitos devem ser comparados de forma sensível. Verdade se bandeira presente.

valores aceites: false, true
--subject-ends-with

Uma cadeia opcional para filtrar eventos para uma subscrição de eventos com base num sufixo. Os caracteres wildcard não são suportados.

az eventgrid topic event-subscription delete

Elimine uma subscrição de evento de um tópico.

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

Exemplos

Elimine uma subscrição de evento para um tópico de Grade de Eventos.

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

Parâmetros Obrigatórios

--name -n

Nome da subscrição do evento.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--topic-name

O nome do tópico.

Parâmetros Opcionais

--yes -y

Não pedir confirmação.

az eventgrid topic event-subscription list

Listar subscrições de eventos de um tópico específico.

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

Exemplos

Lista todas as subscrições de eventos criadas para um tópico de Grade de Eventos.

az eventgrid topic event-subscription list -g rg1 --topic-name topic1

Parâmetros Obrigatórios

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--topic-name

O nome do tópico.

Parâmetros Opcionais

--odata-query

A consulta OData utilizada para filtrar os resultados da lista. Atualmente, a filtragem é permitida apenas na propriedade Name. As operações apoiadas incluem: CONTAINS, eq (para igual), ne (para não igual), E, OR e NÃO.

az eventgrid topic event-subscription show

Obtenha os detalhes de uma subscrição de evento de um tópico.

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

Exemplos

Mostre os detalhes de uma subscrição de evento para um tópico de Grade de Eventos.

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

Mostrar os detalhes de uma subscrição de evento para um tópico de Grade de Eventos incluem quaisquer segredos de atributos de entrega estática.

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

Parâmetros Obrigatórios

--name -n

Nome da subscrição do evento.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--topic-name

O nome do tópico.

Parâmetros Opcionais

--full-ed-url --include-full-endpoint-url

Especificar para indicar se o URL do ponto final completo deve ser devolvido. Verdade se bandeira presente.

valores aceites: false, true
--include-attrib-secret --include-static-delivery-attribute-secret

Indique se os segredos de atributos de entrega estático devem ser devolvidos. Verdade se bandeira presente.

valores aceites: false, true

az eventgrid topic event-subscription update

Atualizar uma subscrição de evento de um tópico.

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

Exemplos

Atualize uma subscrição de eventos para um tópico de Grade de Eventos para especificar um novo ponto final.

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

Atualize uma subscrição de eventos para um tópico de Grade de Eventos para especificar um novo filtro com terminações de assunto.

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

Atualize uma subscrição de eventos para um tópico de Grade de Eventos para especificar um novo ponto final e um novo filtro com fim de assunto com uma nova lista de tipos de eventos incluídos.

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

Atualize uma subscrição de evento para um tópico Azure Event Grid, para incluir um destino deadletter.

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

Atualize uma subscrição de evento para um tópico Azure Event Grid, utilizando filtros avançados.

az eventgrid topic event-subscription update --name es3 \
    -g rg1 --topic-name topic1 \
    --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

Atualize uma subscrição de evento para um tópico de Grade de Eventos com a Fila de Armazenamento como destino com ttl de 5 minutos

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

Atualize uma subscrição de evento para um tópico de Grade de Eventos com filtragem avançada em matrizes ativadas

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

Parâmetros Obrigatórios

--name -n

Nome da subscrição do evento.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name>.

--topic-name

O nome do tópico.

Parâmetros Opcionais

--advanced-filter

Um filtro avançado permite a filtragem de eventos com base numa propriedade específica do evento.

--deadletter-endpoint

O ID de recurso Azure de um destino de contentores de blob de armazenamento Azure onde o EventGrid deve matar eventos não entregues para esta subscrição do evento.

--delivery-attribute-mapping -d

Adicione o mapeamento do atributo de entrega para enviar informações adicionais através de cabeçalhos HTTP ao entregar eventos. Este atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais do que um --delivery-attribute-mapping argumento.

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

Permite que filtros avançados sejam avaliados contra uma matriz de valores em vez de esperar um valor singular.

valores aceites: false, true
--endpoint

Ponto final onde o EventGrid deve entregar eventos correspondentes a esta subscrição do evento. Para o tipo de ponto final webhook, este deve ser o URL webhook correspondente. Para outros tipos de pontos finais, este deve ser o identificador de recursos Azure do ponto final. Espera-se que o ponto final do destino já esteja criado e disponível para utilização antes de executar qualquer comando da Grade de Eventos.

--included-event-types

Uma lista de tipos de eventos separada pelo espaço (por exemplo, Microsoft.Storage.BlobCreated e Microsoft.Storage.BlobDeleted). Para subscrever todos os tipos de eventos predefinidos, não especifique qualquer valor para este argumento. Para tópicos de grelha de eventos, os tipos de eventos são definidos pelo cliente. Para eventos Azure, por exemplo, Contas de Armazenamento, Hub IoT, etc., pode consultar os seus tipos de eventos utilizando este comando CLI 'az eventgrid tipo de lista-tipos de eventos'.

--labels

Uma lista de etiquetas separadas pelo espaço para associar a esta subscrição do evento.

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

Tempo de mensagem de fila de armazenamento para viver em segundos.

--subject-begins-with

Uma cadeia opcional para filtrar eventos para uma subscrição de eventos com base num prefixo. Os caracteres wildcard não são suportados.

--subject-ends-with

Uma cadeia opcional para filtrar eventos para uma subscrição de eventos com base num sufixo. Os caracteres wildcard não são suportados.

--update-endpoint-type

O tipo de destino ponto final.

valores aceites: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook