Partilhar via

az eventgrid topic

  • Referência

Gerenciar tópicos da Grade de Eventos do Azure.

Comandos

Name Description Tipo Status
az eventgrid topic create

Crie um tópico.

 Núcleo GA
az eventgrid topic delete

Excluir um tópico.

 Núcleo GA
az eventgrid topic event-subscription

Gerencie assinaturas de eventos de tópicos.

 Núcleo GA
az eventgrid topic event-subscription create

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

 Núcleo GA
az eventgrid topic event-subscription delete

Excluir uma assinatura de evento de um tópico.

 Núcleo GA
az eventgrid topic event-subscription list

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

 Núcleo GA
az eventgrid topic event-subscription show

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

 Núcleo GA
az eventgrid topic event-subscription update

Atualizar uma assinatura de evento de um tópico.

 Núcleo GA
az eventgrid topic key

Gerenciar chaves de acesso compartilhadas de um tópico.

 Núcleo GA
az eventgrid topic key list

Listar chaves de acesso compartilhadas de um tópico.

 Núcleo GA
az eventgrid topic key regenerate

Regenere uma chave de acesso compartilhada de um tópico.

 Núcleo GA
az eventgrid topic list

Listar tópicos disponíveis.

 Núcleo GA
az eventgrid topic show

Obtenha os detalhes de um tópico.

 Núcleo GA
az eventgrid topic update

Atualize um tópico.

 Núcleo GA

az eventgrid topic create

Editar

Crie um tópico.

az eventgrid topic create --name
                          --resource-group
                          [--extended-location-name]
                          [--extended-location-type {customlocation}]
                          [--identity {noidentity, systemassigned}]
                          [--inbound-ip-rules]
                          [--input-mapping-default-values]
                          [--input-mapping-fields]
                          [--input-schema {cloudeventschemav1_0, customeventschema, eventgridschema}]
                          [--kind {azure, azurearc}]
                          [--location]
                          [--mi-system-assigned]
                          [--mi-user-assigned]
                          [--public-network-access {disabled, enabled}]
                          [--sku {basic, premium}]
                          [--tags]

Exemplos

Crie um novo tópico.

az eventgrid topic create -g rg1 --name topic1 -l westus2

Crie um novo tópico com mapeamentos de entrada personalizados.

az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema customeventschema --input-mapping-fields topic=myTopicField eventType=myEventTypeField --input-mapping-default-values subject=DefaultSubject dataVersion=1.0

Crie um novo tópico que aceite eventos publicados no esquema do CloudEvents V1.0.

az eventgrid topic create -g rg1 --name topic1 -l westus2 --input-schema cloudeventschemav1_0

Crie um novo tópico que permita regras ip de entrada específicas com Sku Básico e identidade atribuída ao sistema

az eventgrid topic create -g rg1 --name topic1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku Basic --identity systemassigned

Crie um novo tópico no Azure.

az eventgrid topic create -g rg1 --name topic1 -l westus2

Crie um novo tópico no Azure.

az eventgrid topic create -g rg1 --name topic1 -l westus2 --kind azure

Crie um novo tópico no AzureArc direcionado a um local personalizado.

az eventgrid topic create -g rg1 --name topic1 -l eastus2euap --kind azurearc --extended-location-name /subscriptions/<subid>/resourcegroups/<rgname>/providers/microsoft.extendedlocation/customlocations/<cust-loc-name> --extended-location-type customlocation --input-schema CloudEventSchemaV1_0

Parâmetros Obrigatórios

--name -n

Nome do tópico.

--resource-group -g

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

Parâmetros Opcionais

--extended-location-name
Pré-visualizar

O nome do local estendido se tipo==azurearc.

--extended-location-type
Pré-visualizar

O tipo de local estendido se tipo==azurearc.

Valores aceites: customlocation
--identity
Pré-visualizar Preterido

O argumento 'identidade' foi preterido e será removido em uma versão futura.

O tipo de identidade gerenciada para o recurso. Será preterido e substituído por --mi-system-assigned-identity no futuro.

Valores aceites: noidentity, systemassigned
--inbound-ip-rules

Lista de regras de IP de entrada.

Lista de regras IP de entrada especificando Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8, juntamente com a ação correspondente a ser executada com base na correspondência ou não correspondência da IpMask. Os valores possíveis incluem - Permitir.

--input-mapping-default-values

Quando input-schema é especificado como customeventschema, esse parâmetro pode ser usado para especificar mapeamentos de entrada com base em valores padrão. Você pode usar esse parâmetro quando seu esquema personalizado não inclui um campo que corresponde a um dos três campos suportados por esse parâmetro. Especifique mapeamentos separados por espaço no formato 'key=value'. Os nomes de chave permitidos são 'subject', 'eventtype', 'dataversion'. Os nomes de valores correspondentes devem especificar os valores padrão a serem usados para o mapeamento e eles serão usados somente quando o evento publicado não tiver um mapeamento válido para um campo específico.

--input-mapping-fields

Quando input-schema é especificado como customeventschema, esse parâmetro é usado para especificar mapeamentos de entrada com base em nomes de campos. Especifique mapeamentos separados por espaço no formato 'key=value'. Os nomes de chave permitidos são 'id', 'topic', 'eventtime', 'subject', 'eventtype', 'dataversion'. Os nomes de valores correspondentes devem especificar os nomes dos campos no esquema de entrada personalizado. Se um mapeamento para 'id' ou 'eventtime' não for fornecido, a Grade de Eventos gerará automaticamente um valor padrão para esses dois campos.

--input-schema

Esquema no qual os eventos de entrada serão publicados neste tópico/domínio. Se você especificar customeventschema como o valor para esse parâmetro, também deverá fornecer valores para pelo menos um dos --input_mapping_default_values / --input_mapping_fields.

Valores aceites: cloudeventschemav1_0, customeventschema, eventgridschema
Default value: eventgridschema
--kind
Pré-visualizar

O tipo de recurso tópico.

Valores aceites: azure, azurearc
Default value: Azure
--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--mi-system-assigned

A presença dessa parada indica que a identidade gerenciada SystemAssigned será usada.

--mi-user-assigned
Pré-visualizar

Adicione identidades atribuídas ao usuário quando identityType for user ou mixed. Esse atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais de um argumento --mi-user-assigned.

--public-network-access

Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando.

Valores aceites: disabled, enabled
--sku
Pré-visualizar

O nome da Sku do recurso.

Valores aceites: basic, premium
Default value: Basic
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

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

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.

az eventgrid topic delete

Editar

Excluir um tópico.

az eventgrid topic delete [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]

Exemplos

Excluir um tópico.

az eventgrid topic delete -g rg1 --name topic1

Parâmetros Opcionais

--ids

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

--name -n

Nome do tópico.

--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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

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

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.

az eventgrid topic list

Editar

Listar tópicos disponíveis.

az eventgrid topic list [--odata-query]
                        [--resource-group]

Exemplos

Liste todos os tópicos na assinatura atual do Azure.

az eventgrid topic list

Liste todos os tópicos em um grupo de recursos.

az eventgrid topic list -g rg1

Listar todos os tópicos em um grupo de recursos cujo nome contém o padrão "XYZ"

az eventgrid topic list -g rg1 --odata-query "Contains(name, 'XYZ')"

Listar todos os tópicos em um grupo de recursos, exceto o domínio com nome "name1"

az eventgrid topic list -g rg1 --odata-query "NOT (name eq 'name1')"

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.

--resource-group -g

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

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

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.

az eventgrid topic show

Editar

Obtenha os detalhes de um tópico.

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

Exemplos

Mostrar os detalhes de um tópico.

az eventgrid topic show -g rg1 -n topic1

Mostrar os detalhes de um tópico com base na ID do recurso.

az eventgrid topic show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1

Parâmetros Opcionais

--ids

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

--name -n

Nome do tópico.

--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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

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

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.

az eventgrid topic update

Editar

Atualize um tópico.

az eventgrid topic update [--identity {noidentity, systemassigned}]
                          [--ids]
                          [--inbound-ip-rules]
                          [--mi-system-assigned]
                          [--mi-user-assigned]
                          [--name]
                          [--public-network-access {disabled, enabled}]
                          [--resource-group]
                          [--sku {basic, premium}]
                          [--subscription]
                          [--tags]

Exemplos

Atualize as propriedades de um tópico existente com novas informações de sku, identidade e acesso à rede pública.

az eventgrid topic update -g rg1 --name topic1 --sku Premium --identity systemassigned --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic

Parâmetros Opcionais

--identity
Pré-visualizar Preterido

O argumento 'identidade' foi preterido e será removido em uma versão futura.

O tipo de identidade gerenciada para o recurso. Será preterido e substituído por --mi-system-assigned-identity no futuro.

Valores aceites: noidentity, systemassigned
--ids

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

--inbound-ip-rules

Lista de regras IP de entrada especificando Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8, juntamente com a ação correspondente a ser executada com base na correspondência ou não correspondência da IpMask. Os valores possíveis incluem - Permitir.

--mi-system-assigned

A presença dessa parada indica que a identidade gerenciada SystemAssigned será usada.

--mi-user-assigned
Pré-visualizar

Adicione identidades atribuídas ao usuário quando identityType for user ou mixed. Esse atributo é válido para todos os tipos de destino, exceto StorageQueue. Vários atributos podem ser especificados usando mais de um argumento --mi-user-assigned.

--name -n

Nome do tópico.

--public-network-access

Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando.

Valores aceites: disabled, enabled
--resource-group -g

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

--sku
Pré-visualizar

O nome da Sku do recurso.

Valores aceites: basic, premium
--subscription

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

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

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

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.