Compartilhar via

az eventgrid topic

  • Referência

Gerenciar tópicos da Grade de Eventos do Azure.

Comandos

Nome Description Tipo Status
az eventgrid topic create

Crie um tópico.

 Núcleo GA
az eventgrid topic delete

Exclua um tópico.

 Núcleo GA
az eventgrid topic event-subscription

Gerenciar assinaturas de evento do tópico.

 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 evento de um tópico específico.

 Núcleo GA
az eventgrid topic event-subscription show

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

 Núcleo GA
az eventgrid topic event-subscription update

Atualize uma assinatura de evento de um tópico.

 Núcleo GA
az eventgrid topic key

Gerenciar chaves de acesso compartilhado de um tópico.

 Núcleo GA
az eventgrid topic key list

Listar chaves de acesso compartilhado de um tópico.

 Núcleo GA
az eventgrid topic key regenerate

Regenerar uma chave de acesso compartilhado 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 CloudEvents V1.0.

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

Criar um novo tópico que permite regras de ip de entrada específicas com sku básico e identidade atribuída pelo 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 direcionando 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 Exigidos

--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
Versão Prévia

O nome do local estendido se kind==azurearc.

--extended-location-type
Versão Prévia

O tipo de local estendido se kind==azurearc.

Valores aceitos: customlocation
--identity
Versão Prévia Preterido

O argumento 'identity' 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 aceitos: noidentity, systemassigned
--inbound-ip-rules

Lista de regras de IP de entrada.

Lista de regras de IP de entrada que especificam o 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 nenhuma correspondência do IpMask. Os valores possíveis incluem - Permitir.

--input-mapping-default-values

Quando o esquema de entrada é 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 o esquema personalizado não incluir um campo que corresponda a um dos três campos compatíveis com 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 valor 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 o esquema de entrada é especificado como customeventschema, esse parâmetro é usado para especificar mapeamentos de entrada com base em nomes de campo. 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 valor 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 desse parâmetro, também deverá fornecer valores para pelo menos um de --input_mapping_default_values/--input_mapping_fields.

Valores aceitos: cloudeventschemav1_0, customeventschema, eventgridschema
Valor padrão: eventgridschema
--kind
Versão Prévia

O tipo de recurso de tópico.

Valores aceitos: azure, azurearc
Valor padrão: 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 desse parâmetro indica que a identidade gerenciada SystemAssigned será usada.

--mi-user-assigned
Versão Prévia

Adicione identidades atribuídas pelo usuário quando identityType for usuário ou misto. 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 pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando.

Valores aceitos: disabled, enabled
--sku
Versão Prévia

O nome do SKU do recurso.

Valores aceitos: basic, premium
Valor padrão: Basic
--tags

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az eventgrid topic delete

Editar

Exclua um tópico.

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

Exemplos

Exclua um tópico.

az eventgrid topic delete -g rg1 --name topic1

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. 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 o 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 com suporte incluem: CONTAINS, eq (para igual), ne (para não igual), AND, OR e NOT.

--resource-group -g

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. 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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. 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
Versão Prévia Preterido

O argumento 'identity' 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 aceitos: noidentity, systemassigned
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--inbound-ip-rules

Lista de regras de IP de entrada que especificam o 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 nenhuma correspondência do IpMask. Os valores possíveis incluem - Permitir.

--mi-system-assigned

A presença desse parâmetro indica que a identidade gerenciada SystemAssigned será usada.

--mi-user-assigned
Versão Prévia

Adicione identidades atribuídas pelo usuário quando identityType for usuário ou misto. 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 pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando.

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

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

--sku
Versão Prévia

O nome do SKU do recurso.

Valores aceitos: basic, premium
--subscription

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

--tags

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.