az eventgrid partner topic event-subscription

Tópico gerenciar assinaturas de evento do parceiro.

Comandos

az eventgrid partner topic event-subscription create

Crie uma nova assinatura de evento para um tópico de parceiro.

az eventgrid partner topic event-subscription delete

Excluir uma assinatura de evento de um tópico de parceiro.

az eventgrid partner topic event-subscription list

Listar assinaturas de evento de um tópico de parceiro específico.

az eventgrid partner topic event-subscription show

Obtenha os detalhes de uma assinatura de evento de um tópico de parceiro.

az eventgrid partner topic event-subscription update

Atualizar uma assinatura de evento de um tópico de parceiro.

az eventgrid partner topic event-subscription create

Crie uma nova assinatura de evento para um tópico de parceiro.

az eventgrid partner topic event-subscription create --name
                                                     --partner-topic-name
                                                     --resource-group
                                                     [--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]

Exemplos

Crie uma nova assinatura de evento para um tópico de parceiro de grade de eventos, usando filtros padrão.

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

Crie uma nova assinatura de evento para um tópico de parceiro de grade de eventos, com um filtro especificando um prefixo de assunto.

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

Crie uma nova assinatura de evento para um tópico de parceiro de grade de eventos, usando filtros padrão e CloudEvent V 1,0 como o esquema de entrega.

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

Crie uma nova assinatura de evento para um partnertopic de grade de eventos, com um destino de mensagens mortas e uma política de repetição personalizada de 10 tentativas de entrega máximas e um TTL de evento de 2 horas (o que acontecer antes) e a data de expiração.

az eventgrid partner topic event-subscription create --name es2 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 de parceiro de grade de eventos, usando Azure Active Directory webhook habilitado como um destino.

az eventgrid partner topic event-subscription create --name es1 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 de parceiro de grade de eventos, usando o Azure function como destino.

az eventgrid partner topic event-subscription create -n es1 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 de parceiro de grade de eventos usando a fila de armazenamento como destino com TTL de mensagem em 5 minutos

az eventgrid partner topic event-subscription create -n es1 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 de parceiro de grade de eventos com filtragem avançada em matrizes habilitada

az eventgrid partner topic event-subscription create -n es1 \
    -g rg1 --partner-topic-name partnertopic1 \
    --endpoint-type storagequeue \
    --endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
    --enable-advanced-filtering-on-arrays true

Parâmetros Exigidos

--name -n

Nome da assinatura do evento.

--partner-topic-name

Nome do tópico do parceiro.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--advanced-filter

Um filtro avançado habilita a filtragem de eventos com base em uma propriedade de evento específica.

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

A ID do aplicativo Azure Active Directory ou o URI 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 um destino.

--azure-active-directory-tenant-id

A ID de locatário 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 um destino.

--deadletter-endpoint

A ID de recurso do Azure de um destino de contêiner de blob de armazenamento do Azure onde EventGrid deve inenviar por email mensagens não entregues para essa assinatura de evento.

--delivery-attribute-mapping

Adicionar mapeamento de atributo de entrega para enviar informações adicionais por meio de cabeçalhos HTTP ao entregar eventos. Esse atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais de um --delivery-attribute-mapping argumento.

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

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

valores aceitos: false, true
--endpoint

Ponto de extremidade em que EventGrid deve entregar eventos que correspondem a essa assinatura de evento. Para o tipo de ponto de extremidade do webhook, deve ser a URL do webhook correspondente. Para outros tipos de ponto de extremidade, 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 de grade de eventos.

--endpoint-type

O tipo do ponto de extremidade de destino.

valores aceitos: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
valor padrão: webhook
--event-delivery-schema

O esquema no qual os eventos devem ser entregues para essa assinatura de evento. Por padrão, os eventos serão entregues no mesmo esquema no qual eles são publicados (com base no esquema de entrada do tópico correspondente).

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

Vida útil do evento (em minutos). Deve ser um número entre 1 e 1440.

valor padrão: 1440
--expiration-date

Date ou DateTime (em UTC, por exemplo, ' 2018-11-30T11:59:59 + 00:00 ' ou ' 2018-11-30 ') após o qual a assinatura de evento expirará. Por padrão, não há nenhuma expiração para a assinatura de evento.

--included-event-types

Uma lista separada por espaços 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 de 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 evento usando este comando de CLI ' AZ eventgrid topic-Type List-Event-types '.

--labels

Uma lista separada por espaços de rótulos a serem associados a essa assinatura de evento.

--max-delivery-attempts

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

valor padrão: 30
--max-events-per-batch

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

--preferred-batch-size-in-kilobytes

Tamanho de lote preferencial em kilobytes. Deve ser um número entre 1 e 1024.

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

Vida útil da mensagem da fila de armazenamento em segundos.

--subject-begins-with

Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um prefixo. Não há suporte para caracteres curinga.

--subject-case-sensitive

Especifique para indicar se os campos de assunto devem ser comparados de maneira diferenciada de maiúsculas e minúsculas. True se o sinalizador estiver presente.

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

Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um sufixo. Não há suporte para caracteres curinga.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az eventgrid partner topic event-subscription delete

Excluir uma assinatura de evento de um tópico de parceiro.

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

Exemplos

Excluir uma assinatura de evento para um tópico de parceiro de grade de eventos.

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

Parâmetros Exigidos

--name -n

Nome da assinatura do evento.

--partner-topic-name

Nome do tópico do parceiro.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

--yes -y

Não solicite confirmação.

az eventgrid partner topic event-subscription list

Listar assinaturas de evento de um tópico de parceiro específico.

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

Exemplos

Lista todas as assinaturas de evento criadas para um tópico de parceiro de grade de eventos.

az eventgrid partner topic event-subscription list -g rg1 --partner-topic-name partnertopic1

Parâmetros Exigidos

--partner-topic-name

Nome do tópico do parceiro.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--odata-query

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 (for igual), ne (para não igual), AND, OR e NOT.

--query-examples

Recomende uma cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colá-la após o parâmetro--Query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chaves.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az eventgrid partner topic event-subscription show

Obtenha os detalhes de uma assinatura de evento de um tópico de parceiro.

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

Exemplos

Mostre os detalhes de uma assinatura de evento para um tópico de parceiro de grade de eventos.

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

Mostrar os detalhes de uma assinatura de evento para um tópico de parceiro de grade de eventos e incluir segredos de atributo de entrega estático

az eventgrid partner topic event-subscription show --name es1 \
     -g rg1 --partner-topic-name partnertopic1 --include-static-delivery-attribute-secret

Parâmetros Exigidos

--name -n

Nome da assinatura do evento.

--partner-topic-name

Nome do tópico do parceiro.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

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

Indique se os segredos de atributo de entrega estático devem ser retornados. True se o sinalizador estiver presente.

valores aceitos: false, true
--include-full-endpoint-url

Especifique para indicar se a URL completa do ponto de extremidade deve ser retornada. True se o sinalizador estiver presente.

valores aceitos: false, true
--query-examples

Recomende uma cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colá-la após o parâmetro--Query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chaves.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az eventgrid partner topic event-subscription update

Atualizar uma assinatura de evento de um tópico de parceiro.

az eventgrid partner topic event-subscription update --name
                                                     --partner-topic-name
                                                     --resource-group
                                                     [--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]

Exemplos

Atualize uma assinatura de evento para um tópico de parceiro de grade de eventos para especificar um novo ponto de extremidade.

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

Atualize uma assinatura de evento para um tópico de parceiro de grade de eventos para especificar um novo filtro de término de entidade-com.

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

Atualizar uma assinatura de evento para um tópico de parceiro de grade de eventos para especificar um novo ponto de extremidade e um novo assunto – com o filtro uma nova lista de tipos de evento incluídos.

az eventgrid partner topic event-subscription update --name es3 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 de parceiro de grade de eventos do Azure, para incluir um destino de mensagens mortas.

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

Atualize uma assinatura de evento para um tópico de parceiro de grade de eventos do Azure, usando filtros avançados.

az eventgrid partner topic event-subscription update --name es3 \
    -g rg1 --partner-topic-name partnertopic1 \
    --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 de parceiro de grade de eventos usando a fila de armazenamento como destino com TTL de mensagem a 5 minutos

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

Atualizar uma assinatura de evento para um tópico de parceiro de grade de eventos com filtragem avançada em matrizes habilitada

az eventgrid partner topic event-subscription update -n es1 \
    -g rg1 --partner-topic-name partnertopic1 \
    --endpoint-type storagequeue \
    --endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
    --enable-advanced-filtering-on-arrays true

Parâmetros Exigidos

--name -n

Nome da assinatura do evento.

--partner-topic-name

Nome do tópico do parceiro.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--advanced-filter

Um filtro avançado habilita a filtragem de eventos com base em uma propriedade de evento específica.

--deadletter-endpoint

A ID de recurso do Azure de um destino de contêiner de blob de armazenamento do Azure onde EventGrid deve inenviar por email mensagens não entregues para essa assinatura de evento.

--delivery-attribute-mapping

Adicionar mapeamento de atributo de entrega para enviar informações adicionais por meio de cabeçalhos HTTP ao entregar eventos. Esse atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais de um --delivery-attribute-mapping argumento.

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

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

valores aceitos: false, true
--endpoint

Ponto de extremidade em que EventGrid deve entregar eventos que correspondem a essa assinatura de evento. Para o tipo de ponto de extremidade do webhook, deve ser a URL do webhook correspondente. Para outros tipos de ponto de extremidade, 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 de grade de eventos.

--endpoint-type

O tipo do ponto de extremidade de destino.

valores aceitos: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
valor padrão: webhook
--included-event-types

Uma lista separada por espaços 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 de 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 evento usando este comando de CLI ' AZ eventgrid topic-Type List-Event-types '.

--labels

Uma lista separada por espaços de rótulos a serem associados a essa assinatura de evento.

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

Vida útil da mensagem da fila de armazenamento em segundos.

--subject-begins-with

Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um prefixo. Não há suporte para caracteres curinga.

--subject-ends-with

Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um sufixo. Não há suporte para caracteres curinga.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .