Share via

az eventgrid system-topic event-subscription

  • Vista previa
  • Referencia

Nota:

Esta referencia forma parte de la extensión eventgrid para la CLI de Azure (versión 2.51.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az eventgrid system-topic event-subscription . Obtenga más información sobre las extensiones.

El grupo de comandos "az eventgrid" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Administrar suscripciones de eventos del tema del sistema.

Comandos

Nombre Description Tipo Estado
az eventgrid system-topic event-subscription create

Cree una nueva suscripción de eventos para un tema del sistema.

 Extensión Versión preliminar
az eventgrid system-topic event-subscription delete

Elimine una suscripción de eventos de un tema del sistema.

 Extensión Versión preliminar
az eventgrid system-topic event-subscription list

Enumerar suscripciones de eventos de un tema de sistema específico.

 Extensión Versión preliminar
az eventgrid system-topic event-subscription show

Obtenga los detalles de una suscripción de eventos de un tema del sistema.

 Extensión Versión preliminar
az eventgrid system-topic event-subscription update

Actualizar una suscripción de eventos de un tema del sistema.

 Extensión Versión preliminar

az eventgrid system-topic event-subscription create

Vista previa

El grupo de comandos "az eventgrid" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree una nueva suscripción de eventos para un tema del 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]

Ejemplos

Cree una nueva suscripción de eventos para un tema del sistema de Event Grid mediante filtros predeterminados.

az eventgrid system-topic event-subscription create --name es1 \
    -g rg1 --system-topic-name systemtopic1 \
    --endpoint https://contoso.azurewebsites.net/api/f1?code=code

Cree una nueva suscripción de eventos para un tema del sistema de Event Grid, con un filtro que especifique un prefijo de asunto.

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

Cree una nueva suscripción de eventos para un tema del sistema de Event Grid, con filtros predeterminados y CloudEvent V 1.0 como 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

Cree una nueva suscripción de eventos para un tema del sistema de Event Grid, con un destino de reintentos fallido y una directiva de reintento personalizado de máximo 10 intentos de entrega y un TTL de eventos de 2 horas (lo que ocurra anteriormente) y la fecha de expiración.

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"

Cree una nueva suscripción de eventos para un tema del sistema de Event Grid mediante el webhook habilitado para Azure Active Directory 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

Cree una nueva suscripción de eventos para un tema del sistema de Event Grid mediante Azure Functions 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 requeridos

--name -n

Nombre de la suscripción de eventos.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--system-topic-name

Nombre del tema del sistema.

Parámetros opcionales

--advanced-filter

Un filtro avanzado habilita el filtrado de eventos en función de una propiedad de evento específica.

Uso: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --advanced-filter data. Color StringIn Azul Rojo Naranja Amarillo StringNotIn: --advanced-filter data. Color StringNotIn Blue Red Orange StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png 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 Se pueden especificar varios filtros avanzados mediante más de un --advanced-filter argumento.

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

Identificador o URI de aplicación de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. Solo se aplica al webhook como destino.

--azure-active-directory-tenant-id

Identificador de inquilino de Azure Active Directory para obtener el token de acceso que se incluirá como token de portador en las solicitudes de entrega. Solo se aplica al webhook como destino.

--deadletter-endpoint

Identificador de recurso de Azure de un destino de contenedor de blobs de Azure Storage en el que EventGrid debe anular la entrega de eventos para esta suscripción de eventos.

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

--endpoint

Punto de conexión donde EventGrid debe entregar eventos que coincidan con esta suscripción de eventos. Para el tipo de punto de conexión de webhook, debe ser la dirección URL de webhook correspondiente. Para otros tipos de punto de conexión, debe ser el identificador de recursos de Azure del punto de conexión.

--endpoint-type

Tipo del punto de conexión de destino.

valores aceptados: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
valor predeterminado: webhook
--event-delivery-schema

Esquema en el que se deben entregar eventos para esta suscripción de eventos. De forma predeterminada, los eventos se entregarán en el mismo esquema en el que se publican (en función del esquema de entrada del tema correspondiente).

valores aceptados: cloudeventschemav1_0, custominputschema, eventgridschema
--event-ttl

Tiempo de vida del evento (en minutos). Debe ser un número comprendido entre 1 y 1440.

valor predeterminado: 1440
--expiration-date

Fecha o fecha y hora (en UTC, por ejemplo, "2018-11-30T11:59:59+00:00" o "2018-11-30") después de la cual expiraría la suscripción de eventos. De forma predeterminada, no hay ninguna expiración para la suscripción de eventos.

--included-event-types

Una lista separada por espacios de tipos de eventos. Ejemplo: Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted. Para suscribirse a todos los tipos de eventos predeterminados, no especifique ningún valor para este argumento.

--labels

Lista separada por espacios de etiquetas que se van a asociar a esta suscripción de eventos.

--max-delivery-attempts

Número máximo de intentos de entrega. Debe ser un número comprendido entre 1 y 30.

valor predeterminado: 30
--max-events-per-batch

Número máximo de eventos en un lote. Debe ser un número entre 1 y 5000.

--preferred-batch-size-in-kilobytes

Tamaño de lote preferido en kilobytes. Debe ser un número entre 1 y 1024.

--subject-begins-with

Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo. No se admite el uso de caracteres comodín.

--subject-case-sensitive

Especifique para indicar si los campos de asunto deben compararse de forma confidencial entre mayúsculas y minúsculas. True si la marca está presente.

valores aceptados: false, true
valor predeterminado: False
--subject-ends-with

Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo. No se admite el uso de caracteres comodín.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid system-topic event-subscription delete

Vista previa

El grupo de comandos "az eventgrid" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Elimine una suscripción de eventos de un tema del sistema.

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

Ejemplos

Elimine una suscripción de eventos para un tema del sistema de Event Grid.

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

Parámetros requeridos

--name -n

Nombre de la suscripción de eventos.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--system-topic-name

Nombre del tema del sistema.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid system-topic event-subscription list

Vista previa

El grupo de comandos "az eventgrid" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Enumerar suscripciones de eventos de un tema de sistema específico.

az eventgrid system-topic event-subscription list --resource-group
                                                  --system-topic-name
                                                  [--odata-query]

Ejemplos

Enumere todas las suscripciones de eventos creadas para un tema del sistema de Event Grid.

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

Parámetros requeridos

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--system-topic-name

Nombre del tema del sistema.

Parámetros opcionales

--odata-query

Consulta que se usa para filtrar los resultados mediante la sintaxis de OData.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid system-topic event-subscription show

Vista previa

El grupo de comandos "az eventgrid" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Obtenga los detalles de una suscripción de eventos de un tema del sistema.

az eventgrid system-topic event-subscription show --name
                                                  --resource-group
                                                  --system-topic-name
                                                  [--include-full-endpoint-url {false, true}]

Ejemplos

Muestra los detalles de una suscripción de eventos para un tema del sistema de Event Grid.

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

Parámetros requeridos

--name -n

Nombre de la suscripción de eventos.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--system-topic-name

Nombre del tema del sistema.

Parámetros opcionales

--include-full-endpoint-url

Especifique para indicar si se debe devolver la dirección URL completa del punto de conexión. True si la marca está presente.

valores aceptados: false, true
valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az eventgrid system-topic event-subscription update

Vista previa

El grupo de comandos "az eventgrid" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Actualizar una suscripción de eventos de un tema del 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]

Ejemplos

Actualice una suscripción de eventos para un tema del sistema de Event Grid para especificar un nuevo punto de conexión.

az eventgrid system-topic event-subscription update --name es1 \
    -g rg1 --system-topic-name systemtopic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code

Actualice una suscripción de eventos para un tema del sistema de Event Grid para especificar un nuevo filtro subject-ends-with.

az eventgrid system-topic event-subscription update --name es2 \
    -g rg1 --system-topic-name systemtopic1 \
    --subject-ends-with .jpg

Actualice una suscripción de eventos para un tema del sistema de Event Grid para especificar un nuevo punto de conexión y un nuevo subject-ends- con filtrar una nueva lista de tipos de eventos incluidos.

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

Actualice una suscripción de eventos para un tema del sistema de Azure Event Grid para incluir un destino de deadletter.

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

Actualice una suscripción de eventos para un tema del sistema de Azure Event Grid mediante filtros avanzados.

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 requeridos

--name -n

Nombre de la suscripción de eventos.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--system-topic-name

Nombre del tema del sistema.

Parámetros opcionales

--advanced-filter

Un filtro avanzado habilita el filtrado de eventos en función de una propiedad de evento específica.

Uso: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --advanced-filter data. Color StringIn Azul Rojo Naranja Amarillo StringNotIn: --advanced-filter data. Color StringNotIn Blue Red Orange StringContains: --advanced-filter subject StringContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png 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 Se pueden especificar varios filtros avanzados mediante más de un --advanced-filter argumento.

--deadletter-endpoint

Identificador de recurso de Azure de un destino de contenedor de blobs de Azure Storage en el que EventGrid debe anular la entrega de eventos para esta suscripción de eventos.

--endpoint

Punto de conexión donde EventGrid debe entregar eventos que coincidan con esta suscripción de eventos. Para el tipo de punto de conexión de webhook, debe ser la dirección URL de webhook correspondiente. Para otros tipos de punto de conexión, debe ser el identificador de recursos de Azure del punto de conexión.

--endpoint-type

Tipo del punto de conexión de destino.

valores aceptados: azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook
valor predeterminado: webhook
--included-event-types

Una lista separada por espacios de tipos de eventos. Ejemplo: Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted. Para suscribirse a todos los tipos de eventos predeterminados, no especifique ningún valor para este argumento.

--labels

Lista separada por espacios de etiquetas que se van a asociar a esta suscripción de eventos.

--subject-begins-with

Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo. No se admite el uso de caracteres comodín.

--subject-ends-with

Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo. No se admite el uso de caracteres comodín.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.