Compartilhar via

az eventgrid namespace topic event-subscription

  • Versão Prévia
  • Referência

Observação

Essa referência faz parte da extensão eventgrid para a CLI do Azure (versão 2.51.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az eventgrid namespace topic event-subscription . Saiba mais sobre extensões.

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

Gerenciar a assinatura de evento de tópico do namespace eventgrid.

Comandos

Nome Description Tipo Status
az eventgrid namespace topic event-subscription create

Crie uma assinatura de evento de um tópico de namespace.

 Extensão Visualizar
az eventgrid namespace topic event-subscription delete

Exclua uma assinatura de evento existente de um tópico de namespace.

 Extensão Visualizar
az eventgrid namespace topic event-subscription list

Listar assinaturas de eventos que pertencem a um tópico de namespace específico.

 Extensão Visualizar
az eventgrid namespace topic event-subscription show

Mostrar uma assinatura de evento de um tópico de namespace.

 Extensão Visualizar
az eventgrid namespace topic event-subscription update

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

 Extensão Visualizar
az eventgrid namespace topic event-subscription wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extensão Visualizar

az eventgrid namespace topic event-subscription create

Versão Prévia

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

Crie uma assinatura de evento de um tópico de namespace.

az eventgrid namespace topic event-subscription create --event-subscription-name
                                                       --namespace-name
                                                       --resource-group
                                                       --topic-name
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--filters-configuration]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Exemplos

Criar assinatura de evento

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --delivery-configuration "{deliveryMode:Queue,queue:{receiveLockDurationInSeconds:60,maxDeliveryCount:4,eventTimeToLive:P1D}}"

Parâmetros Exigidos

--event-subscription-name --name -n

Nome da assinatura do evento que será criado. Os nomes de assinatura de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

--namespace-name

Nome do namespace.

--resource-group -g

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

--topic-name

Nome do tópico do namespace.

Parâmetros Opcionais

--delivery-configuration

Informações sobre a configuração de entrega da assinatura do evento. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--event-delivery-schema

O esquema de entrega de eventos para a assinatura do evento.

Valores aceitos: CloudEventSchemaV1_0
--filters-configuration

Informações sobre o filtro para a inscrição do evento. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventgrid namespace topic event-subscription delete

Versão Prévia

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

Exclua uma assinatura de evento existente de um tópico de namespace.

az eventgrid namespace topic event-subscription delete [--event-subscription-name]
                                                       [--ids]
                                                       [--namespace-name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--subscription]
                                                       [--topic-name]
                                                       [--yes]

Exemplos

Excluir assinatura de evento

az eventgrid namespace topic event-subscription delete -g rg --topic-name topic -n event-subscription --namespace-name name

Parâmetros Opcionais

--event-subscription-name --name -n

Nome da assinatura do evento que será criado. Os nomes de assinatura de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--namespace-name

Nome do namespace.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--topic-name

Nome do tópico do namespace.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventgrid namespace topic event-subscription list

Versão Prévia

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

Listar assinaturas de eventos que pertencem a um tópico de namespace específico.

az eventgrid namespace topic event-subscription list --namespace-name
                                                     --resource-group
                                                     --topic-name
                                                     [--filter]
                                                     [--max-items]
                                                     [--next-token]
                                                     [--top]

Exemplos

Listar assinatura de evento

az eventgrid namespace topic event-subscription list -g rg --topic-name topic --namespace-name name

Parâmetros Exigidos

--namespace-name

Nome do namespace.

--resource-group -g

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

--topic-name

Nome do tópico do namespace.

Parâmetros Opcionais

--filter

A consulta usada para filtrar os resultados da pesquisa usando a sintaxe OData. A filtragem é permitida apenas na propriedade 'name' e com um número limitado de operações OData. Essas operações são: a função 'contém', bem como as seguintes operações lógicas: não, e, ou, eq (para igual) e ne (para não igual). Não há suporte para operações aritméticas. Veja a seguir um exemplo de filtro válido: $filter=contains(namE, 'PATTERN') e name ne 'PATTERN-1'. O seguinte não é um exemplo de filtro válido: $filter=location eq 'westus'.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor de token de uma resposta truncada anteriormente.

--top

O número de resultados a serem retornados por página para a operação de lista. O intervalo válido para o parâmetro superior é de 1 a 100. Se não for especificado, o número padrão de resultados a serem retornados será de 20 itens por página.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventgrid namespace topic event-subscription show

Versão Prévia

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

Mostrar uma assinatura de evento de um tópico de namespace.

az eventgrid namespace topic event-subscription show [--event-subscription-name]
                                                     [--ids]
                                                     [--namespace-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--topic-name]

Exemplos

Mostrar assinatura do evento

az eventgrid namespace topic event-subscription show -g rg --topic-name topic -n event-subscription --namespace-name name

Parâmetros Opcionais

--event-subscription-name --name -n

Nome da assinatura do evento que será criado. Os nomes de assinatura de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--namespace-name

Nome do namespace.

--resource-group -g

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

--subscription

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

--topic-name

Nome do tópico do namespace.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventgrid namespace topic event-subscription update

Versão Prévia

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

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

az eventgrid namespace topic event-subscription update [--add]
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--event-subscription-name]
                                                       [--filters-configuration]
                                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--ids]
                                                       [--namespace-name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--remove]
                                                       [--resource-group]
                                                       [--set]
                                                       [--subscription]
                                                       [--topic-name]

Exemplos

Atualizar assinatura de evento

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --filters-configuration "{includedEventTypes:['All']}"

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string ou cadeia de caracteres> JSON.

--delivery-configuration

Informações sobre a configuração de entrega da assinatura do evento. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--event-delivery-schema

O esquema de entrega de eventos para a assinatura do evento.

Valores aceitos: CloudEventSchemaV1_0
--event-subscription-name --name -n

Nome da assinatura do evento que será criado. Os nomes de assinatura de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

--filters-configuration

Informações sobre o filtro para a inscrição do evento. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--namespace-name

Nome do namespace.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OU --remove propertyToRemove.

--resource-group -g

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

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

--subscription

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

--topic-name

Nome do tópico do namespace.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az eventgrid namespace topic event-subscription wait

Versão Prévia

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

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az eventgrid namespace topic event-subscription wait [--created]
                                                     [--custom]
                                                     [--deleted]
                                                     [--event-subscription-name]
                                                     [--exists]
                                                     [--ids]
                                                     [--interval]
                                                     [--namespace-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--timeout]
                                                     [--topic-name]
                                                     [--updated]

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--event-subscription-name --name -n

Nome da assinatura do evento que será criado. Os nomes de assinatura de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

--exists

Aguarde até que o recurso exista.

Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--namespace-name

Nome do namespace.

--resource-group -g

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

--subscription

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

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--topic-name

Nome do tópico do namespace.

--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.