Partilhar via


az eventgrid namespace topic event-subscription

Note

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 pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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

Comandos

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

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

Extension Preview
az eventgrid namespace topic event-subscription delete

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

Extension Preview
az eventgrid namespace topic event-subscription list

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

Extension Preview
az eventgrid namespace topic event-subscription show

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

Extension Preview
az eventgrid namespace topic event-subscription update

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

Extension Preview
az eventgrid namespace topic event-subscription wait

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

Extension Preview

az eventgrid namespace topic event-subscription create

Pré-visualizar

O grupo de comandos 'az eventgrid namespace topic event-subscription' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 --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 subscrição 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 Obrigatórios

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

Nome da assinatura de evento a ser criada. Os nomes das assinaturas 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--delivery-configuration

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--event-delivery-schema

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: CloudEventSchemaV1_0
--filters-configuration

Informações sobre o filtro para a assinatura do evento. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az eventgrid namespace topic event-subscription delete

Pré-visualizar

O grupo de comandos 'az eventgrid namespace topic event-subscription' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 --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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Nome da assinatura de evento a ser criada. Os nomes das assinaturas de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--namespace-name

Nome do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 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>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--topic-name

Nome do tópico do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False

az eventgrid namespace topic event-subscription list

Pré-visualizar

O grupo de comandos 'az eventgrid namespace topic event-subscription' 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 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 Obrigatórios

--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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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. Estas operações são: a função «contém», bem como as seguintes operações lógicas: not, e, ou, eq (para igual) e ne (para não igual). Nenhuma operação aritmética é suportada. Segue-se 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 em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--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 é de 20 itens por página.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az eventgrid namespace topic event-subscription show

Pré-visualizar

O grupo de comandos 'az eventgrid namespace topic event-subscription' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 --name]
                                                     [--ids]
                                                     [--namespace-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--topic-name]

Exemplos

Mostrar subscrição de eventos

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Nome da assinatura de evento a ser criada. Os nomes das assinaturas de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--namespace-name

Nome do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--topic-name

Nome do tópico do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False

az eventgrid namespace topic event-subscription update

Pré-visualizar

O grupo de comandos 'az eventgrid namespace topic event-subscription' 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 de namespace.

az eventgrid namespace topic event-subscription update [--add]
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--event-subscription-name --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 subscrição de eventos

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--add

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--delivery-configuration

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--event-delivery-schema

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

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: CloudEventSchemaV1_0
--event-subscription-name --name -n

Nome da assinatura de evento a ser criada. Os nomes das assinaturas de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--filters-configuration

Informações sobre o filtro para a assinatura do evento. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--namespace-name

Nome do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--topic-name

Nome do tópico do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False

az eventgrid namespace topic event-subscription wait

Pré-visualizar

O grupo de comandos 'az eventgrid namespace topic event-subscription' está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: 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 --name]
                                                     [--exists]
                                                     [--ids]
                                                     [--interval]
                                                     [--namespace-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--timeout]
                                                     [--topic-name]
                                                     [--updated]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--custom

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--event-subscription-name --name -n

Nome da assinatura de evento a ser criada. Os nomes das assinaturas de eventos devem ter entre 3 e 100 caracteres e usar apenas letras alfanuméricas.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 30
--namespace-name

Nome do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 3600
--topic-name

Nome do tópico do namespace.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False