System Topic Event Subscriptions - Create Or Update

Servicio:

Event Grid

Versión de la API:

2022-06-15

Cree o actualice una suscripción de eventos para un tema del sistema.
Crea o actualiza de forma asincrónica una suscripción de eventos con los parámetros especificados. Las suscripciones de eventos existentes se actualizarán con esta API.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}?api-version=2022-06-15

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
eventSubscriptionName	path	True	string	Nombre de la suscripción de eventos que se va a crear. Los nombres de suscripción de eventos deben tener entre 3 y 100 caracteres de longitud y usar solo letras alfanuméricas.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción del usuario.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
systemTopicName	path	True	string	Nombre del tema del sistema.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos. Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity	Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos. Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity	Información sobre el destino donde se deben entregar los eventos para la suscripción de eventos. Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.destination	EventSubscriptionDestination: WebHookEventSubscriptionDestination EventHubEventSubscriptionDestination StorageQueueEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination AzureFunctionEventSubscriptionDestination	Información sobre el destino donde se deben entregar los eventos para la suscripción de eventos. Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.eventDeliverySchema	EventDeliverySchema	Esquema de entrega de eventos para la suscripción de eventos.
properties.expirationTimeUtc	string	Hora de expiración de la suscripción de eventos.
properties.filter	EventSubscriptionFilter	Información sobre el filtro de la suscripción de eventos.
properties.labels	string[]	Lista de etiquetas definidas por el usuario.
properties.retryPolicy	RetryPolicy	Directiva de reintento para eventos. Esto se puede usar para configurar el número máximo de intentos de entrega y el tiempo de vida de los eventos.

Respuestas

Nombre	Tipo	Description
201 Created	EventSubscription	Creado
Other Status Codes		Respuestas de error: *** 400 Solicitud incorrecta. 500 Internal Server Error.

Ejemplos

SystemTopicEventSubscriptions_CreateOrUpdate

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionInner;
import com.azure.resourcemanager.eventgrid.models.EventSubscriptionFilter;
import com.azure.resourcemanager.eventgrid.models.WebhookEventSubscriptionDestination;

/** Samples for SystemTopicEventSubscriptions CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
     */
    /**
     * Sample code: SystemTopicEventSubscriptions_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void systemTopicEventSubscriptionsCreateOrUpdate(
        com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .systemTopicEventSubscriptions()
            .createOrUpdate(
                "examplerg",
                "exampleSystemTopic1",
                "exampleEventSubscriptionName1",
                new EventSubscriptionInner()
                    .withDestination(
                        new WebhookEventSubscriptionDestination().withEndpointUrl("https://requestb.in/15ksip71"))
                    .withFilter(
                        new EventSubscriptionFilter()
                            .withSubjectBeginsWith("ExamplePrefix")
                            .withSubjectEndsWith("ExampleSuffix")
                            .withIsSubjectCaseSensitive(false)),
                Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python system_topic_event_subscriptions_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.system_topic_event_subscriptions.begin_create_or_update(
        resource_group_name="examplerg",
        system_topic_name="exampleSystemTopic1",
        event_subscription_name="exampleEventSubscriptionName1",
        event_subscription_info={
            "properties": {
                "destination": {
                    "endpointType": "WebHook",
                    "properties": {"endpointUrl": "https://requestb.in/15ksip71"},
                },
                "filter": {
                    "isSubjectCaseSensitive": False,
                    "subjectBeginsWith": "ExamplePrefix",
                    "subjectEndsWith": "ExampleSuffix",
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
func ExampleSystemTopicEventSubscriptionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSystemTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleSystemTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
		Properties: &armeventgrid.EventSubscriptionProperties{
			Destination: &armeventgrid.WebHookEventSubscriptionDestination{
				EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
				Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
					EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
				},
			},
			Filter: &armeventgrid.EventSubscriptionFilter{
				IsSubjectCaseSensitive: to.Ptr(false),
				SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
				SubjectEndsWith:        to.Ptr("ExampleSuffix"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 *
 * @summary Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
 */
async function systemTopicEventSubscriptionsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const systemTopicName = "exampleSystemTopic1";
  const eventSubscriptionName = "exampleEventSubscriptionName1";
  const eventSubscriptionInfo = {
    destination: {
      endpointType: "WebHook",
      endpointUrl: "https://requestb.in/15ksip71",
    },
    filter: {
      isSubjectCaseSensitive: false,
      subjectBeginsWith: "ExamplePrefix",
      subjectEndsWith: "ExampleSuffix",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.systemTopicEventSubscriptions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    systemTopicName,
    eventSubscriptionName,
    eventSubscriptionInfo
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.EventGrid.Models;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
// this example is just showing the usage of "SystemTopicEventSubscriptions_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SystemTopicResource created on azure
// for more information of creating SystemTopicResource, please refer to the document of SystemTopicResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string systemTopicName = "exampleSystemTopic1";
ResourceIdentifier systemTopicResourceId = SystemTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, systemTopicName);
SystemTopicResource systemTopic = client.GetSystemTopicResource(systemTopicResourceId);

// get the collection of this SystemTopicEventSubscriptionResource
SystemTopicEventSubscriptionCollection collection = systemTopic.GetSystemTopicEventSubscriptions();

// invoke the operation
string eventSubscriptionName = "exampleEventSubscriptionName1";
EventGridSubscriptionData data = new EventGridSubscriptionData()
{
    Destination = new WebHookEventSubscriptionDestination()
    {
        Endpoint = new Uri("https://requestb.in/15ksip71"),
    },
    Filter = new EventSubscriptionFilter()
    {
        SubjectBeginsWith = "ExamplePrefix",
        SubjectEndsWith = "ExampleSuffix",
        IsSubjectCaseSensitive = false,
    },
};
ArmOperation<SystemTopicEventSubscriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, eventSubscriptionName, data);
SystemTopicEventSubscriptionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EventGridSubscriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

201

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": null,
    "eventDeliverySchema": "EventGridSchema",
    "retryPolicy": {
      "maxDeliveryAttempts": 30,
      "eventTimeToLiveInMinutes": 1440
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1",
  "name": "exampleEventSubscriptionName1",
  "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions"
}

Definiciones

Nombre	Description
AzureFunctionEventSubscriptionDestination	Información sobre el destino de la función de Azure para una suscripción de eventos.
BoolEqualsAdvancedFilter	Filtro avanzado boolEquals.
createdByType	Tipo de identidad que creó el recurso.
DeadLetterWithResourceIdentity	Información sobre el destino de mensajes fallidos con la identidad del recurso.
DeliveryWithResourceIdentity	Información sobre la entrega de una suscripción de eventos con identidad de recurso.
DynamicDeliveryAttributeMapping	Detalles de asignación de atributos de entrega dinámica.
EventDeliverySchema	Esquema de entrega de eventos para la suscripción de eventos.
EventHubEventSubscriptionDestination	Información sobre el destino del centro de eventos para una suscripción de eventos.
EventSubscription	Suscripción a eventos
EventSubscriptionFilter	Filtre por la suscripción de eventos.
EventSubscriptionIdentity	Información de identidad con la suscripción de eventos.
EventSubscriptionIdentityType	Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.
EventSubscriptionProvisioningState	Estado de aprovisionamiento de la suscripción de eventos.
HybridConnectionEventSubscriptionDestination	Información sobre el destino de HybridConnection para una suscripción de eventos.
IsNotNullAdvancedFilter	Filtro avanzado IsNotNull.
IsNullOrUndefinedAdvancedFilter	Filtro avanzado IsNullOrUndefined.
NumberGreaterThanAdvancedFilter	NumberGreaterThan Advanced Filter.
NumberGreaterThanOrEqualsAdvancedFilter	Filtro avanzado NumberGreaterThanOrEquals.
NumberInAdvancedFilter	Filtro avanzado NumberIn.
NumberInRangeAdvancedFilter	Filtro avanzado NumberInRange.
NumberLessThanAdvancedFilter	Filtro avanzado NumberLessThan.
NumberLessThanOrEqualsAdvancedFilter	Filtro avanzado NumberLessThanOrEquals.
NumberNotInAdvancedFilter	Filtro avanzado NumberNotIn.
NumberNotInRangeAdvancedFilter	Filtro avanzado NumberNotInRange.
RetryPolicy	Información sobre la directiva de reintento para una suscripción de eventos.
ServiceBusQueueEventSubscriptionDestination	Información sobre el destino de Service Bus para una suscripción de eventos.
ServiceBusTopicEventSubscriptionDestination	Información sobre el destino del tema de Service Bus para una suscripción de eventos.
StaticDeliveryAttributeMapping	Detalles de asignación de atributos de entrega estática.
StorageBlobDeadLetterDestination	Información sobre el destino de mensajes fallidos basado en blobs de almacenamiento.
StorageQueueEventSubscriptionDestination	Información sobre el destino de la cola de almacenamiento para una suscripción de eventos.
StringBeginsWithAdvancedFilter	StringBeginsWith Advanced Filter.
StringContainsAdvancedFilter	StringContains Advanced Filter.
StringEndsWithAdvancedFilter	StringEndsWith Advanced Filter.
StringInAdvancedFilter	Filtro avanzado stringIn.
StringNotBeginsWithAdvancedFilter	StringNotBeginsWith Advanced Filter.
StringNotContainsAdvancedFilter	StringNotContains Advanced Filter.
StringNotEndsWithAdvancedFilter	StringNotEndsWith Advanced Filter.
StringNotInAdvancedFilter	Filtro avanzado StringNotIn.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
WebHookEventSubscriptionDestination	Información sobre el destino de webhook para una suscripción de eventos.

AzureFunctionEventSubscriptionDestination

Información sobre el destino de la función de Azure para una suscripción de eventos.

Nombre	Tipo	Valor predeterminado	Description
endpointType	string: AzureFunction		Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Detalles del atributo de entrega.
properties.maxEventsPerBatch	integer	1	Número máximo de eventos por lote.
properties.preferredBatchSizeInKilobytes	integer	64	Tamaño de lote preferido en Kilobytes.
properties.resourceId	string		Identificador de recurso de Azure que representa el punto de conexión del destino de la función de Azure de una suscripción de eventos.

BoolEqualsAdvancedFilter

Filtro avanzado boolEquals.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: BoolEquals	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value	boolean	Valor de filtro booleano.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DeadLetterWithResourceIdentity

Información sobre el destino de mensajes fallidos con la identidad del recurso.

Nombre	Tipo	Description
deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	Información sobre el destino donde se deben entregar los eventos para la suscripción de eventos. Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
identity	EventSubscriptionIdentity	Identidad que se va a usar cuando se produzcan eventos de mensajes fallidos.

DeliveryWithResourceIdentity

Información sobre la entrega de una suscripción de eventos con identidad de recurso.

Nombre	Tipo	Description
destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination	Información sobre el destino donde se deben entregar los eventos para la suscripción de eventos. Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
identity	EventSubscriptionIdentity	Identidad que se va a usar al entregar eventos.

DynamicDeliveryAttributeMapping

Detalles de asignación de atributos de entrega dinámica.

Nombre	Tipo	Description
name	string	Nombre del atributo o encabezado de entrega.
properties.sourceField	string	Ruta de acceso JSON en el evento que contiene el valor del atributo.
type	string: Dynamic	Tipo del atributo de entrega o el nombre del encabezado.

EventDeliverySchema

Esquema de entrega de eventos para la suscripción de eventos.

Nombre	Tipo	Description
CloudEventSchemaV1_0	string
CustomInputSchema	string
EventGridSchema	string

EventHubEventSubscriptionDestination

Información sobre el destino del centro de eventos para una suscripción de eventos.

Nombre	Tipo	Description
endpointType	string: EventHub	Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalles del atributo de entrega.
properties.resourceId	string	Identificador de recurso de Azure que representa el punto de conexión de un destino del centro de eventos de una suscripción de eventos.

EventSubscription

Suscripción a eventos

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador completo del recurso.
name	string		Nombre del recurso.
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination		Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos. Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity		Destino de mensajes fallidos de la suscripción de eventos. Cualquier evento que no se pueda entregar a su destino se envía al destino de mensajes fallidos. Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity		Información sobre el destino donde se deben entregar los eventos para la suscripción de eventos. Usa la configuración de identidad administrada en el recurso primario (es decir, tema o dominio) para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination		Información sobre el destino donde se deben entregar los eventos para la suscripción de eventos. Usa la identidad de Azure Event Grid para adquirir los tokens de autenticación que se usan durante la entrega o los mensajes fallidos.
properties.eventDeliverySchema	EventDeliverySchema	EventGridSchema	Esquema de entrega de eventos para la suscripción de eventos.
properties.expirationTimeUtc	string		Hora de expiración de la suscripción de eventos.
properties.filter	EventSubscriptionFilter		Información sobre el filtro de la suscripción de eventos.
properties.labels	string[]		Lista de etiquetas definidas por el usuario.
properties.provisioningState	EventSubscriptionProvisioningState		Estado de aprovisionamiento de la suscripción de eventos.
properties.retryPolicy	RetryPolicy		Directiva de reintento para eventos. Esto se puede usar para configurar el número máximo de intentos de entrega y el tiempo de vida de los eventos.
properties.topic	string		Nombre del tema de la suscripción de eventos.
systemData	systemData		Metadatos del sistema relacionados con el recurso de suscripción de eventos.
type	string		Tipo de recurso.

EventSubscriptionFilter

Filtre por la suscripción de eventos.

Nombre	Tipo	Valor predeterminado	Description
advancedFilters	AdvancedFilter[]: BoolEqualsAdvancedFilter[] IsNotNullAdvancedFilter[] IsNullOrUndefinedAdvancedFilter[] NumberGreaterThanAdvancedFilter[] NumberGreaterThanOrEqualsAdvancedFilter[] NumberInAdvancedFilter[] NumberInRangeAdvancedFilter[] NumberLessThanAdvancedFilter[] NumberLessThanOrEqualsAdvancedFilter[] NumberNotInAdvancedFilter[] NumberNotInRangeAdvancedFilter[] StringBeginsWithAdvancedFilter[] StringContainsAdvancedFilter[] StringEndsWithAdvancedFilter[] StringInAdvancedFilter[] StringNotBeginsWithAdvancedFilter[] StringNotContainsAdvancedFilter[] StringNotEndsWithAdvancedFilter[] StringNotInAdvancedFilter[]		Matriz de filtros avanzados que se usan para filtrar suscripciones de eventos.
enableAdvancedFilteringOnArrays	boolean		Permite evaluar filtros avanzados en una matriz de valores en lugar de esperar un valor singular.
includedEventTypes	string[]		Lista de tipos de eventos aplicables que deben formar parte de la suscripción de eventos. Si desea suscribirse a todos los tipos de eventos predeterminados, establezca IncludedEventTypes en null.
isSubjectCaseSensitive	boolean	False	Especifica si las propiedades SubjectBeginsWith y SubjectEndsWith del filtro deben compararse de una manera que distingue mayúsculas de minúsculas.
subjectBeginsWith	string		Cadena opcional para filtrar eventos de una suscripción de eventos en función de un prefijo de ruta de acceso de recurso. El formato de esto depende del publicador de los eventos. Los caracteres comodín no se admiten en esta ruta de acceso.
subjectEndsWith	string		Cadena opcional para filtrar eventos de una suscripción de eventos en función de un sufijo de ruta de acceso de recurso. Los caracteres comodín no se admiten en esta ruta de acceso.

EventSubscriptionIdentity

Información de identidad con la suscripción de eventos.

Nombre	Tipo	Description
type	EventSubscriptionIdentityType	Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.
userAssignedIdentity	string	Identidad del usuario asociada al recurso.

EventSubscriptionIdentityType

Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.

Nombre	Tipo	Description
SystemAssigned	string
UserAssigned	string

EventSubscriptionProvisioningState

Estado de aprovisionamiento de la suscripción de eventos.

Nombre	Tipo	Description
AwaitingManualAction	string
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

HybridConnectionEventSubscriptionDestination

Información sobre el destino de HybridConnection para una suscripción de eventos.

Nombre	Tipo	Description
endpointType	string: HybridConnection	Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalles del atributo de entrega.
properties.resourceId	string	Identificador de recurso de Azure de una conexión híbrida que es el destino de una suscripción de eventos.

IsNotNullAdvancedFilter

Filtro avanzado IsNotNull.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: IsNotNull	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.

IsNullOrUndefinedAdvancedFilter

Filtro avanzado IsNullOrUndefined.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: IsNullOrUndefined	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.

NumberGreaterThanAdvancedFilter

NumberGreaterThan Advanced Filter.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberGreaterThan	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value	number	El valor de filtro.

NumberGreaterThanOrEqualsAdvancedFilter

Filtro avanzado NumberGreaterThanOrEquals.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberGreaterThanOrEquals	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value	number	El valor de filtro.

NumberInAdvancedFilter

Filtro avanzado NumberIn.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberIn	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	number[]	Conjunto de valores de filtro.

NumberInRangeAdvancedFilter

Filtro avanzado NumberInRange.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberInRange	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	number[]	Conjunto de valores de filtro.

NumberLessThanAdvancedFilter

Filtro avanzado NumberLessThan.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberLessThan	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value	number	El valor de filtro.

NumberLessThanOrEqualsAdvancedFilter

Filtro avanzado NumberLessThanOrEquals.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberLessThanOrEquals	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
value	number	El valor de filtro.

NumberNotInAdvancedFilter

Filtro avanzado NumberNotIn.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberNotIn	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	number[]	Conjunto de valores de filtro.

NumberNotInRangeAdvancedFilter

Filtro avanzado NumberNotInRange.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: NumberNotInRange	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	number[]	Conjunto de valores de filtro.

RetryPolicy

Información sobre la directiva de reintento para una suscripción de eventos.

Nombre	Tipo	Valor predeterminado	Description
eventTimeToLiveInMinutes	integer	1440	Período de vida (en minutos) para eventos.
maxDeliveryAttempts	integer	30	Número máximo de reintentos de entrega para eventos.

ServiceBusQueueEventSubscriptionDestination

Información sobre el destino de Service Bus para una suscripción de eventos.

Nombre	Tipo	Description
endpointType	string: ServiceBusQueue	Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalles del atributo de entrega.
properties.resourceId	string	Identificador de recurso de Azure que representa el punto de conexión del destino de Service Bus de una suscripción de eventos.

ServiceBusTopicEventSubscriptionDestination

Información sobre el destino del tema de Service Bus para una suscripción de eventos.

Nombre	Tipo	Description
endpointType	string: ServiceBusTopic	Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalles del atributo de entrega.
properties.resourceId	string	Identificador de recurso de Azure que representa el punto de conexión del destino del tema de Service Bus de una suscripción de eventos.

StaticDeliveryAttributeMapping

Detalles de asignación de atributos de entrega estática.

Nombre	Tipo	Valor predeterminado	Description
name	string		Nombre del atributo o encabezado de entrega.
properties.isSecret	boolean	False	Marca booleana para indicar si el atributo contiene información confidencial.
properties.value	string		Valor del atributo de entrega.
type	string: Static		Tipo del atributo de entrega o el nombre del encabezado.

StorageBlobDeadLetterDestination

Información sobre el destino de mensajes fallidos basado en blobs de almacenamiento.

Nombre	Tipo	Description
endpointType	string: StorageBlob	Tipo del punto de conexión para el destino de mensajes fallidos
properties.blobContainerName	string	Nombre del contenedor de blobs de Storage que es el destino de los eventos deadletter.
properties.resourceId	string	Identificador de recurso de Azure de la cuenta de almacenamiento que es el destino de los eventos deadletter.

StorageQueueEventSubscriptionDestination

Información sobre el destino de la cola de almacenamiento para una suscripción de eventos.

Nombre	Tipo	Description
endpointType	string: StorageQueue	Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.queueMessageTimeToLiveInSeconds	integer	Tiempo de vida del mensaje de la cola de almacenamiento en segundos.
properties.queueName	string	Nombre de la cola de Storage en una cuenta de almacenamiento que es el destino de una suscripción de eventos.
properties.resourceId	string	Identificador de recurso de Azure de la cuenta de almacenamiento que contiene la cola que es el destino de una suscripción de eventos.

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringBeginsWith	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

StringContainsAdvancedFilter

StringContains Advanced Filter.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringContains	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringEndsWith	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

StringInAdvancedFilter

Filtro avanzado stringIn.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringIn	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringNotBeginsWith	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

StringNotContainsAdvancedFilter

StringNotContains Advanced Filter.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringNotContains	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringNotEndsWith	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

StringNotInAdvancedFilter

Filtro avanzado StringNotIn.

Nombre	Tipo	Description
key	string	Campo o propiedad en el evento en función del cual desea filtrar.
operatorType	string: StringNotIn	Tipo de operador utilizado para filtrar, por ejemplo, NumberIn, StringContains, BoolEquals y otros.
values	string[]	Conjunto de valores de filtro.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

WebHookEventSubscriptionDestination

Información sobre el destino de webhook para una suscripción de eventos.

Nombre	Tipo	Valor predeterminado	Description
endpointType	string: WebHook		Tipo del punto de conexión para el destino de la suscripción de eventos.
properties.azureActiveDirectoryApplicationIdOrUri	string		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.
properties.azureActiveDirectoryTenantId	string		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.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Detalles del atributo de entrega.
properties.endpointBaseUrl	string		Dirección URL base que representa el punto de conexión del destino de una suscripción de eventos.
properties.endpointUrl	string		Dirección URL que representa el punto de conexión del destino de una suscripción de eventos.
properties.maxEventsPerBatch	integer	1	Número máximo de eventos por lote.
properties.preferredBatchSizeInKilobytes	integer	64	Tamaño de lote preferido en Kilobytes.