Partilhar via

az eventgrid system-topic event-subscription

  • Referência

Nota

Este grupo de comandos tem comandos definidos na CLI do Azure e em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Gerenciar assinaturas de eventos do tópico do sistema.

Comandos

Name Description Tipo Status
az eventgrid system-topic event-subscription create

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

 Principal GA
az eventgrid system-topic event-subscription create (eventgrid extensão)

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

 Extensão Pré-visualizar
az eventgrid system-topic event-subscription delete

Excluir uma assinatura de evento de um tópico do sistema.

 Principal GA
az eventgrid system-topic event-subscription delete (eventgrid extensão)

Excluir uma assinatura de evento de um tópico do sistema.

 Extensão Pré-visualizar
az eventgrid system-topic event-subscription list

Listar assinaturas de eventos de um tópico específico do sistema.

 Principal GA
az eventgrid system-topic event-subscription list (eventgrid extensão)

Listar assinaturas de eventos de um tópico específico do sistema.

 Extensão Pré-visualizar
az eventgrid system-topic event-subscription show

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

 Principal GA
az eventgrid system-topic event-subscription show (eventgrid extensão)

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

 Extensão Pré-visualizar
az eventgrid system-topic event-subscription update

Atualizar uma assinatura de evento de um tópico do sistema.

 Principal GA
az eventgrid system-topic event-subscription update (eventgrid extensão)

Atualizar uma assinatura de evento de um tópico do sistema.

 Extensão Pré-visualizar

az eventgrid system-topic event-subscription create

Editar

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 de 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 de 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 de Grade de Eventos, usando filtros padrão e o 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 de Grade de Eventos, com um destino de letra morta 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 primeiro) e 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 de Grade de Eventos, usando o Webhook habilitado para o Ative Directory do Azure 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 de 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 de 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 de 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 Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

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

A ID de Locatário do Azure Ative Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável apenas para webhook como destino.

--advanced-filter

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

Uso: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALOR [VALOR ...] StringIn: --advanced-filter data. Cor StringIn Azul Vermelho Laranja Amarelo StringNotIn: --advanced-filter data. Cor StringNotIn Azul Vermelho Laranja Amarelo StringContains: --assunto de filtro avançado StringContains Vermelho Azul StringNotContains: --assunto de filtro avançado StringNotContains Vermelho Azul StringBeginsWith: --assunto de filtro avançado StringBeginsCom vermelho azul StringNotBeginsWith: --assunto de filtro avançado StringNotBeginsCom vermelho azul StringEndsWith: --assunto de filtro avançado StringEndsWith img png jpg StringNotEndsWith: --sujeito de filtro avançado 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 NumberNotInRange 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 --advanced-filter argumento.

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

A ID ou Uri do Aplicativo do Azure Ative Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável apenas para webhook como destino.

--deadletter-endpoint

A ID de recurso do Azure de um destino de contêiner de blob de Armazenamento do Azure onde EventGrid deve fazer deadletter de eventos não entregues para esta assinatura de evento.

Exemplo: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName.

--delivery-attribute-mapping

Adicione o mapeamento de atributos 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.

Uso: --delivery-attribute-mapping attribute-name attribute-type attribute-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 static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.

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

Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.

Valores aceites: false, true
--endpoint

Ponto de extremidade onde o EventGrid deve fornecer eventos correspondentes a essa assinatura de evento. Para o tipo de ponto de extremidade webhook, este deve ser o 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.

--endpoint-type

O tipo do ponto de extremidade de destino.

Valores aceites: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
Default value: webhook
--event-delivery-schema

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 em que são publicados (com base no esquema de entrada do tópico correspondente).

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

Tempo de vida do evento (em minutos). Deve ser um número entre 1 e 1440.

Default value: 1440
--expiration-date

Data ou data/hora (em UTC, por exemplo, '2018-11-30T11:59:59+00:00' ou '2018-11-30') após a qual a subscrição do evento expiraria. Por padrão, não há expiração para a assinatura do evento.

--included-event-types

Uma lista separada por espaços de tipos de eventos (por exemplo, Microsoft.Storage.BlobCreated e Microsoft.Storage.BlobDeleted). Para se inscrever em 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 da CLI 'az eventgrid topic-type list-event-types'.

--labels

Uma lista separada por espaços de etiquetas para associar a esta subscrição de evento.

--max-delivery-attempts

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

Default value: 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 preferido em kilobytes. Deve ser um número entre 1 e 1024.

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

Tempo de vida da mensagem da fila de armazenamento em segundos.

--subject-begins-with

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.

--subject-case-sensitive

Especificar para indicar se os campos temáticos devem ser comparados de uma forma que diferencie maiúsculas de minúsculas. True se a bandeira estiver presente.

Valores aceites: false, true
Default value: False
--subject-ends-with

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 de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription create (eventgrid extensão)

Pré-visualizar

O grupo de comandos 'az eventgrid' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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
                                                    [--advanced-filter]
                                                    [--azure-active-directory-application-id-or-uri]
                                                    [--azure-active-directory-tenant-id]
                                                    [--deadletter-endpoint]
                                                    [--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]
                                                    [--subject-begins-with]
                                                    [--subject-case-sensitive {false, true}]
                                                    [--subject-ends-with]

Exemplos

Crie uma nova assinatura de evento para um tópico do sistema de 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 de 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 de Grade de Eventos, usando filtros padrão e o 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 de Grade de Eventos, com um destino de letra morta 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 primeiro) e 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 de Grade de Eventos, usando o Webhook habilitado para o Ative Directory do Azure 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 de 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

Parâmetros Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

--advanced-filter

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

Uso: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALOR [VALOR ...] StringIn: --advanced-filter data. Cor StringIn Azul Vermelho Laranja Amarelo StringNotIn: --advanced-filter data. Cor StringNotIn Azul Vermelho Laranja Amarelo StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg NumberIn: --advanced-filter data.property1 NumberIn 5 10 20 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 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 Vários filtros avançados podem ser especificados usando mais de um --advanced-filter argumento.

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

A ID ou Uri do Aplicativo do Azure Ative Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável apenas para webhook como destino.

--azure-active-directory-tenant-id

A ID de Locatário do Azure Ative Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. Aplicável apenas para webhook como destino.

--deadletter-endpoint

A ID de recurso do Azure de um destino de contêiner de blob de Armazenamento do Azure onde EventGrid deve fazer deadletter de eventos não entregues para esta assinatura de evento.

Exemplo: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/containerName.

--endpoint

Ponto de extremidade onde o EventGrid deve fornecer eventos correspondentes a essa assinatura de evento. Para o tipo de ponto de extremidade webhook, este deve ser o URL de webhook correspondente. Para outros tipos de ponto de extremidade, esse deve ser o identificador de recurso do Azure do ponto de extremidade.

--endpoint-type

O tipo do ponto de extremidade de destino.

Valores aceites: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
Default value: webhook
--event-delivery-schema

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 em que são publicados (com base no esquema de entrada do tópico correspondente).

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

Tempo de vida do evento (em minutos). Deve ser um número entre 1 e 1440.

Default value: 1440
--expiration-date

Data ou data/hora (em UTC, por exemplo, '2018-11-30T11:59:59+00:00' ou '2018-11-30') após a qual a subscrição do evento expiraria. Por padrão, não há expiração para a assinatura do evento.

--included-event-types

Uma lista separada por espaços de tipos de eventos. Exemplo: Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted. Para assinar todos os tipos de evento padrão, não especifique nenhum valor para esse argumento.

--labels

Uma lista separada por espaços de etiquetas para associar a esta subscrição de evento.

--max-delivery-attempts

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

Default value: 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 preferido em kilobytes. Deve ser um número entre 1 e 1024.

--subject-begins-with

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.

--subject-case-sensitive

Especificar para indicar se os campos temáticos devem ser comparados de uma forma que diferencie maiúsculas de minúsculas. True se a bandeira estiver presente.

Valores aceites: false, true
Default value: False
--subject-ends-with

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 de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription delete

Editar

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

Excluir uma assinatura de evento para um tópico do sistema de Grade de Eventos.

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

Parâmetros Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

--yes -y

Não solicite confirmação.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription delete (eventgrid extensão)

Pré-visualizar

O grupo de comandos 'az eventgrid' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Excluir uma assinatura de evento de um tópico do sistema.

az eventgrid system-topic event-subscription delete --name
                                                    --resource-group
                                                    --system-topic-name

Exemplos

Excluir uma assinatura de evento para um tópico do sistema de Grade de Eventos.

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

Parâmetros Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription list

Editar

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 eventos criadas para um tópico do sistema Grade de Eventos.

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

Parâmetros Obrigatórios

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

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 suportadas incluem: CONTÉM, eq (para igual), ne (para não igual), E, OU e NÃO.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription list (eventgrid extensão)

Pré-visualizar

O grupo de comandos 'az eventgrid' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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 eventos criadas para um tópico do sistema Grade de Eventos.

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

Parâmetros Obrigatórios

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

--odata-query

A consulta usada para filtrar os resultados usando a sintaxe OData.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription show

Editar

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 de 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 de Grade de Eventos inclui quaisquer 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 Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

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

Indique se algum segredo de atributo de entrega estático deve ser retornado. True se a bandeira estiver presente.

Valores aceites: false, true
Default value: False
--include-full-endpoint-url

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

Valores aceites: false, true
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription show (eventgrid extensão)

Pré-visualizar

O grupo de comandos 'az eventgrid' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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-full-endpoint-url {false, true}]

Exemplos

Mostrar os detalhes de uma assinatura de evento para um tópico do sistema de Grade de Eventos.

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

Parâmetros Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

--include-full-endpoint-url

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

Valores aceites: false, true
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription update

Editar

Atualizar 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 de 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 de Grade de Eventos para especificar um novo filtro assunto-termina-com.

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 de Grade de Eventos para especificar um novo ponto de extremidade e um novo filtro de assunto-termina-com 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 de Grade de Eventos do Azure, para incluir um destino de letra morta.

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

Atualizar uma assinatura de evento para um tópico do sistema de 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 de Grade de Eventos com 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 de Grade de Eventos com filtragem avançada em matrizes habilitada

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

Parâmetros Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

--advanced-filter

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

Uso: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALOR [VALOR ...] StringIn: --advanced-filter data. Cor StringIn Azul Vermelho Laranja Amarelo StringNotIn: --advanced-filter data. Cor StringNotIn Azul Vermelho Laranja Amarelo StringContains: --assunto de filtro avançado StringContains Vermelho Azul StringNotContains: --assunto de filtro avançado StringNotContains Vermelho Azul StringBeginsWith: --assunto de filtro avançado StringBeginsCom vermelho azul StringNotBeginsWith: --assunto de filtro avançado StringNotBeginsCom vermelho azul StringEndsWith: --assunto de filtro avançado StringEndsWith img png jpg StringNotEndsWith: --sujeito de filtro avançado 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 NumberNotInRange 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 --advanced-filter argumento.

--deadletter-endpoint

A ID de recurso do Azure de um destino de contêiner de blob de Armazenamento do Azure onde EventGrid deve fazer deadletter de eventos não entregues para esta assinatura de evento.

--delivery-attribute-mapping

Adicione o mapeamento de atributos 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.

Uso: --delivery-attribute-mapping attribute-name attribute-type attribute-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 static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.

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

Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.

Valores aceites: false, true
--endpoint

Ponto de extremidade onde o EventGrid deve fornecer eventos correspondentes a essa assinatura de evento. Para o tipo de ponto de extremidade webhook, este deve ser o 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.

--endpoint-type

O tipo do ponto de extremidade de destino.

Valores aceites: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
Default value: webhook
--included-event-types

Uma lista separada por espaços de tipos de eventos (por exemplo, Microsoft.Storage.BlobCreated e Microsoft.Storage.BlobDeleted). Para se inscrever em 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 da CLI 'az eventgrid topic-type list-event-types'.

--labels

Uma lista separada por espaços de etiquetas para associar a esta subscrição de evento.

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

Tempo de vida da mensagem da fila de armazenamento em segundos.

--subject-begins-with

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.

--subject-ends-with

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 de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az eventgrid system-topic event-subscription update (eventgrid extensão)

Pré-visualizar

O grupo de comandos 'az eventgrid' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualizar 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]
                                                    [--endpoint]
                                                    [--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
                                                    [--included-event-types]
                                                    [--labels]
                                                    [--subject-begins-with]
                                                    [--subject-ends-with]

Exemplos

Atualize uma assinatura de evento para um tópico do sistema de 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 de Grade de Eventos para especificar um novo filtro assunto-termina-com.

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 de Grade de Eventos para especificar um novo ponto de extremidade e um novo filtro de assunto-termina-com 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 de Grade de Eventos do Azure, para incluir um destino de letra morta.

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

Atualizar uma assinatura de evento para um tópico do sistema de 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

Parâmetros Obrigatórios

--name -n

Nome da assinatura do evento.

--resource-group -g

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

--system-topic-name

Nome do tópico do sistema.

Parâmetros Opcionais

--advanced-filter

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

Uso: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALOR [VALOR ...] StringIn: --advanced-filter data. Cor StringIn Azul Vermelho Laranja Amarelo StringNotIn: --advanced-filter data. Cor StringNotIn Azul Vermelho Laranja Amarelo StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg NumberIn: --advanced-filter data.property1 NumberIn 5 10 20 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 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 Vários filtros avançados podem ser especificados usando mais de um --advanced-filter argumento.

--deadletter-endpoint

A ID de recurso do Azure de um destino de contêiner de blob de Armazenamento do Azure onde EventGrid deve fazer deadletter de eventos não entregues para esta assinatura de evento.

--endpoint

Ponto de extremidade onde o EventGrid deve fornecer eventos correspondentes a essa assinatura de evento. Para o tipo de ponto de extremidade webhook, este deve ser o URL de webhook correspondente. Para outros tipos de ponto de extremidade, esse deve ser o identificador de recurso do Azure do ponto de extremidade.

--endpoint-type

O tipo do ponto de extremidade de destino.

Valores aceites: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
Default value: webhook
--included-event-types

Uma lista separada por espaços de tipos de eventos. Exemplo: Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted. Para assinar todos os tipos de evento padrão, não especifique nenhum valor para esse argumento.

--labels

Uma lista separada por espaços de etiquetas para associar a esta subscrição de evento.

--subject-begins-with

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.

--subject-ends-with

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 de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.