Domain Topic Event Subscriptions - Create Or Update

Serviço:

Event Grid

Versão da API:

2025-02-15

Crie ou atualize uma assinatura de evento aninhada para um tópico de domínio.
Cria de forma assíncrona uma nova assinatura de evento ou atualiza uma assinatura de evento existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}?api-version=2025-02-15

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
domainName	path	True	string	Nome do domínio de nível superior.
eventSubscriptionName	path	True	string	Nome da assinatura do evento a ser criada. Os nomes de assinatura de evento devem ter entre 3 e 64 caracteres de comprimento e usar somente letras alfanuméricas.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
topicName	path	True	string	Nome do tópico de domínio.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

Nome	Tipo	Description
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta morta. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity	O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta morta. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.destination	EventSubscriptionDestination: WebHookEventSubscriptionDestination EventHubEventSubscriptionDestination StorageQueueEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination AzureFunctionEventSubscriptionDestination MonitorAlertEventSubscriptionDestination NamespaceTopicEventSubscriptionDestination	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.eventDeliverySchema	EventDeliverySchema	O esquema de entrega de eventos para a assinatura do evento.
properties.expirationTimeUtc	string (date-time)	Hora de expiração da assinatura do evento.
properties.filter	EventSubscriptionFilter	Informações sobre o filtro da assinatura do evento.
properties.labels	string[]	Lista de rótulos definidos pelo usuário.
properties.retryPolicy	RetryPolicy	A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida útil para eventos.

Respostas

Nome	Tipo	Description
200 OK	EventSubscription	OKEY
201 Created	EventSubscription	Criado
Other Status Codes		Respostas de erro: *** 400 Solicitação Incorreta. 500 Erro interno do servidor.

Exemplos

DomainTopicEventSubscriptions_CreateOrUpdate

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/topics/exampleDomainTopic1/eventSubscriptions/exampleEventSubscriptionName1?api-version=2025-02-15

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

Java

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

/**
 * Samples for DomainTopicEventSubscriptions CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/
     * DomainTopicEventSubscriptions_CreateOrUpdate.json
     */
    /**
     * Sample code: DomainTopicEventSubscriptions_CreateOrUpdate.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void
        domainTopicEventSubscriptionsCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.domainTopicEventSubscriptions().createOrUpdate("examplerg", "exampleDomain1", "exampleDomainTopic1",
            "exampleEventSubscriptionName1",
            new EventSubscriptionInner()
                .withDestination(
                    new WebhookEventSubscriptionDestination().withEndpointUrl("https://requestb.in/15ksip71"))
                .withFilter(new EventSubscriptionFilter().withSubjectBeginsWith("ExamplePrefix")
                    .withSubjectEndsWith("ExampleSuffix").withIsSubjectCaseSensitive(false)),
            com.azure.core.util.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 domain_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.domain_topic_event_subscriptions.begin_create_or_update(
        resource_group_name="examplerg",
        domain_name="exampleDomain1",
        topic_name="exampleDomainTopic1",
        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/2025-02-15/examples/DomainTopicEventSubscriptions_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/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/DomainTopicEventSubscriptions_CreateOrUpdate.json
func ExampleDomainTopicEventSubscriptionsClient_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.NewDomainTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleDomain1", "exampleDomainTopic1", "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)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EventSubscription = armeventgrid.EventSubscription{
	// 	Name: to.Ptr("exampleEventSubscriptionName1"),
	// 	Type: to.Ptr("Microsoft.EventGrid/domains/domainTopics/eventSubscriptions"),
	// 	ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1/eventSubscriptions/exampleEventSubscriptionName1"),
	// 	Properties: &armeventgrid.EventSubscriptionProperties{
	// 		Destination: &armeventgrid.WebHookEventSubscriptionDestination{
	// 			EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
	// 			Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
	// 				EndpointBaseURL: to.Ptr("https://requestb.in/15ksip71"),
	// 			},
	// 		},
	// 		EventDeliverySchema: to.Ptr(armeventgrid.EventDeliverySchemaEventGridSchema),
	// 		Filter: &armeventgrid.EventSubscriptionFilter{
	// 			IsSubjectCaseSensitive: to.Ptr(false),
	// 			SubjectBeginsWith: to.Ptr("ExamplePrefix"),
	// 			SubjectEndsWith: to.Ptr("ExampleSuffix"),
	// 		},
	// 		ProvisioningState: to.Ptr(armeventgrid.EventSubscriptionProvisioningStateSucceeded),
	// 		RetryPolicy: &armeventgrid.RetryPolicy{
	// 			EventTimeToLiveInMinutes: to.Ptr[int32](1440),
	// 			MaxDeliveryAttempts: to.Ptr[int32](30),
	// 		},
	// 		Topic: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1"),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Asynchronously creates a new event subscription or updates an existing event subscription.
 *
 * @summary Asynchronously creates a new event subscription or updates an existing event subscription.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/DomainTopicEventSubscriptions_CreateOrUpdate.json
 */
async function domainTopicEventSubscriptionsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const domainName = "exampleDomain1";
  const topicName = "exampleDomainTopic1";
  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.domainTopicEventSubscriptions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    domainName,
    topicName,
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventGrid.Models;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/DomainTopicEventSubscriptions_CreateOrUpdate.json
// this example is just showing the usage of "DomainTopicEventSubscriptions_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 DomainTopicResource created on azure
// for more information of creating DomainTopicResource, please refer to the document of DomainTopicResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string domainName = "exampleDomain1";
string topicName = "exampleDomainTopic1";
ResourceIdentifier domainTopicResourceId = DomainTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, domainName, topicName);
DomainTopicResource domainTopic = client.GetDomainTopicResource(domainTopicResourceId);

// get the collection of this DomainTopicEventSubscriptionResource
DomainTopicEventSubscriptionCollection collection = domainTopic.GetDomainTopicEventSubscriptions();

// 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<DomainTopicEventSubscriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, eventSubscriptionName, data);
DomainTopicEventSubscriptionResource 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

Resposta de exemplo

Código de status:

200

{
  "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/domains/exampleDomain1/domainTopics/exampleDomainTopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1/eventSubscriptions/exampleEventSubscriptionName1",
  "name": "exampleEventSubscriptionName1",
  "type": "Microsoft.EventGrid/domains/domainTopics/eventSubscriptions"
}

Código de status:

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/domains/exampleDomain1/domainTopics/exampleDomainTopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampleDomain1/domainTopics/exampleDomainTopic1/eventSubscriptions/exampleEventSubscriptionName1",
  "name": "exampleEventSubscriptionName1",
  "type": "Microsoft.EventGrid/domains/domainTopics/eventSubscriptions"
}

Definições

Nome	Description
AzureFunctionEventSubscriptionDestination	Informações sobre o destino da função do azure para uma assinatura de evento.
BoolEqualsAdvancedFilter	Filtro Avançado boolEquals.
createdByType	O tipo de identidade que criou o recurso.
DeadLetterWithResourceIdentity	Informações sobre o destino deadletter com a identidade do recurso.
DeliveryWithResourceIdentity	Informações sobre a entrega de uma assinatura de evento com identidade de recurso.
DynamicDeliveryAttributeMapping	Detalhes de mapeamento de atributo de entrega dinâmica.
EventDeliverySchema	O esquema de entrega de eventos para a assinatura do evento.
EventHubEventSubscriptionDestination	Informações sobre o destino do hub de eventos para uma assinatura de evento.
EventSubscription	Assinatura de evento.
EventSubscriptionFilter	Filtrar a assinatura do evento.
EventSubscriptionIdentity	As informações de identidade com a assinatura do evento.
EventSubscriptionIdentityType	O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'.
EventSubscriptionProvisioningState	Estado de provisionamento da assinatura do evento.
HybridConnectionEventSubscriptionDestination	Informações sobre o destino HybridConnection para uma assinatura de evento.
IsNotNullAdvancedFilter	Filtro Avançado IsNotNull.
IsNullOrUndefinedAdvancedFilter	Filtro Avançado IsNullOrUndefined.
MonitorAlertEventSubscriptionDestination	Informações sobre o destino do Monitor Alert para uma assinatura de evento.
MonitorAlertSeverity	A severidade que será anexada a todos os alertas disparados por meio dessa assinatura de evento. Esse campo deve ser fornecido.
NamespaceTopicEventSubscriptionDestination	Informações sobre o destino do Tópico do Namespace para uma assinatura de evento.
NumberGreaterThanAdvancedFilter	Filtro Avançado NumberGreaterThan.
NumberGreaterThanOrEqualsAdvancedFilter	Filtro Avançado NumberGreaterThanOrEquals.
NumberInAdvancedFilter	Filtro Avançado NumberIn.
NumberInRangeAdvancedFilter	Filtro Avançado NumberInRange.
NumberLessThanAdvancedFilter	Filtro Avançado NumberLessThan.
NumberLessThanOrEqualsAdvancedFilter	Filtro Avançado NumberLessThanOrEquals.
NumberNotInAdvancedFilter	Filtro Avançado NumberNotIn.
NumberNotInRangeAdvancedFilter	Filtro Avançado NumberNotInRange.
RetryPolicy	Informações sobre a política de repetição de uma assinatura de evento.
ServiceBusQueueEventSubscriptionDestination	Informações sobre o destino do barramento de serviço para uma assinatura de evento.
ServiceBusTopicEventSubscriptionDestination	Informações sobre o destino do tópico do barramento de serviço para uma assinatura de evento.
StaticDeliveryAttributeMapping	Detalhes do mapeamento de atributo de entrega estática.
StorageBlobDeadLetterDestination	Informações sobre o destino de mensagens mortas baseadas em blob de armazenamento.
StorageQueueEventSubscriptionDestination	Informações sobre o destino da fila de armazenamento para uma assinatura de evento.
StringBeginsWithAdvancedFilter	StringBeginsWith Advanced Filter.
StringContainsAdvancedFilter	Filtro Avançado StringContains.
StringEndsWithAdvancedFilter	StringEndsWith Advanced Filter.
StringInAdvancedFilter	Filtro Avançado StringIn.
StringNotBeginsWithAdvancedFilter	StringNotBeginsWith Advanced Filter.
StringNotContainsAdvancedFilter	Filtro Avançado StringNotContains.
StringNotEndsWithAdvancedFilter	StringNotEndsWith Advanced Filter.
StringNotInAdvancedFilter	Filtro Avançado StringNotIn.
systemData	Metadados relativos à criação e última modificação do recurso.
TlsVersion	Versão mínima do TLS do publicador com permissão para publicar neste domínio
WebHookEventSubscriptionDestination	Informações sobre o destino do webhook para uma assinatura de evento.

AzureFunctionEventSubscriptionDestination

Objeto

Informações sobre o destino da função do azure para uma assinatura de evento.

Nome	Tipo	Valor padrão	Description
endpointType	string: AzureFunction		Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Detalhes do atributo de entrega.
properties.maxEventsPerBatch	integer (int32)	1	Número máximo de eventos por lote.
properties.preferredBatchSizeInKilobytes	integer (int32)	64	Tamanho de lote preferencial em Kilobytes.
properties.resourceId	string (arm-id)		A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento.

BoolEqualsAdvancedFilter

Objeto

Filtro Avançado boolEquals.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: BoolEquals	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	boolean	O valor do filtro booliano.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DeadLetterWithResourceIdentity

Objeto

Informações sobre o destino deadletter com a identidade do recurso.

Nome	Tipo	Description
deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante as mensagens mortas.
identity	EventSubscriptionIdentity	A identidade a ser usada quando eventos de mensagens mortas.

DeliveryWithResourceIdentity

Objeto

Informações sobre a entrega de uma assinatura de evento com identidade de recurso.

Nome	Tipo	Description
destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination MonitorAlertEventSubscriptionDestination NamespaceTopicEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega.
identity	EventSubscriptionIdentity	A identidade a ser usada ao fornecer eventos.

DynamicDeliveryAttributeMapping

Objeto

Detalhes de mapeamento de atributo de entrega dinâmica.

Nome	Tipo	Description
name	string	Nome do atributo ou cabeçalho de entrega.
properties.sourceField	string	Caminho JSON no evento que contém o valor do atributo.
type	string: Dynamic	Tipo do atributo de entrega ou nome do cabeçalho.

EventDeliverySchema

Enumeração

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

Valor	Description
CloudEventSchemaV1_0
CustomInputSchema
EventGridSchema

EventHubEventSubscriptionDestination

Objeto

Informações sobre o destino do hub de eventos para uma assinatura de evento.

Nome	Tipo	Description
endpointType	string: EventHub	Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string (arm-id)	A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento.

EventSubscription

Objeto

Assinatura de evento.

Nome	Tipo	Valor padrão	Description
id	string		Identificador totalmente qualificado do recurso.
name	string		Nome do recurso.
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination		O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta morta. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity		O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta morta. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity		Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination MonitorAlertEventSubscriptionDestination NamespaceTopicEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination		Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.
properties.eventDeliverySchema	EventDeliverySchema	EventGridSchema	O esquema de entrega de eventos para a assinatura do evento.
properties.expirationTimeUtc	string (date-time)		Hora de expiração da assinatura do evento.
properties.filter	EventSubscriptionFilter		Informações sobre o filtro da assinatura do evento.
properties.labels	string[]		Lista de rótulos definidos pelo usuário.
properties.provisioningState	EventSubscriptionProvisioningState		Estado de provisionamento da assinatura do evento.
properties.retryPolicy	RetryPolicy		A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida útil para eventos.
properties.topic	string		Nome do tópico da assinatura do evento.
systemData	systemData		Os metadados do sistema relacionados ao recurso da Grade de Eventos.
type	string		Tipo do recurso.

EventSubscriptionFilter

Objeto

Filtrar a assinatura do evento.

Nome	Tipo	Valor padrão	Description
advancedFilters	AdvancedFilter[]: BoolEqualsAdvancedFilter[] IsNotNullAdvancedFilter[] IsNullOrUndefinedAdvancedFilter[] NumberGreaterThanAdvancedFilter[] NumberGreaterThanOrEqualsAdvancedFilter[] NumberInAdvancedFilter[] NumberInRangeAdvancedFilter[] NumberLessThanAdvancedFilter[] NumberLessThanOrEqualsAdvancedFilter[] NumberNotInAdvancedFilter[] NumberNotInRangeAdvancedFilter[] StringBeginsWithAdvancedFilter[] StringContainsAdvancedFilter[] StringEndsWithAdvancedFilter[] StringInAdvancedFilter[] StringNotBeginsWithAdvancedFilter[] StringNotContainsAdvancedFilter[] StringNotEndsWithAdvancedFilter[] StringNotInAdvancedFilter[]		Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos.
enableAdvancedFilteringOnArrays	boolean		Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular.
includedEventTypes	string[]		Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo.
isSubjectCaseSensitive	boolean	False	Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro devem ser comparadas de maneira sensível a maiúsculas de minúsculas.
subjectBeginsWith	string		Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.
subjectEndsWith	string		Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.

EventSubscriptionIdentity

Objeto

As informações de identidade com a assinatura do evento.

Nome	Tipo	Description
type	EventSubscriptionIdentityType	O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'.
userAssignedIdentity	string	A identidade do usuário associada ao recurso.

EventSubscriptionIdentityType

Enumeração

O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'.

Valor	Description
SystemAssigned
UserAssigned

EventSubscriptionProvisioningState

Enumeração

Estado de provisionamento da assinatura do evento.

Valor	Description
AwaitingManualAction
Canceled
Creating
Deleting
Failed
Succeeded
Updating

HybridConnectionEventSubscriptionDestination

Objeto

Informações sobre o destino HybridConnection para uma assinatura de evento.

Nome	Tipo	Description
endpointType	string: HybridConnection	Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string (arm-id)	A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento.

IsNotNullAdvancedFilter

Objeto

Filtro Avançado IsNotNull.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: IsNotNull	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.

IsNullOrUndefinedAdvancedFilter

Objeto

Filtro Avançado IsNullOrUndefined.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: IsNullOrUndefined	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.

MonitorAlertEventSubscriptionDestination

Objeto

Informações sobre o destino do Monitor Alert para uma assinatura de evento.

Nome	Tipo	Description
endpointType	string: MonitorAlert	Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.actionGroups	string[] (arm-id)	A lista de IDs do ARM de Grupos de Ações que serão disparadas em cada alerta disparado por meio dessa assinatura de evento. Cada ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
properties.description	string	A descrição que será anexada a todos os Alertas disparados por meio dessa assinatura de evento.
properties.severity	MonitorAlertSeverity	A severidade que será anexada a todos os alertas disparados por meio dessa assinatura de evento. Esse campo deve ser fornecido.

MonitorAlertSeverity

Enumeração

A severidade que será anexada a todos os alertas disparados por meio dessa assinatura de evento. Esse campo deve ser fornecido.

Valor	Description
Sev0
Sev1
Sev2
Sev3
Sev4

NamespaceTopicEventSubscriptionDestination

Objeto

Informações sobre o destino do Tópico do Namespace para uma assinatura de evento.

Nome	Tipo	Description
endpointType	string: NamespaceTopic	Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.resourceId	string (arm-id)	A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico do Namespace da Grade de Eventos de uma assinatura de evento. Esse campo é necessário e o recurso Tópico do Namespace listado já deve existir. A ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.

NumberGreaterThanAdvancedFilter

Objeto

Filtro Avançado NumberGreaterThan.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberGreaterThan	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number (double)	O valor do filtro.

NumberGreaterThanOrEqualsAdvancedFilter

Objeto

Filtro Avançado NumberGreaterThanOrEquals.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberGreaterThanOrEquals	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number (double)	O valor do filtro.

NumberInAdvancedFilter

Objeto

Filtro Avançado NumberIn.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberIn	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[] (double)	O conjunto de valores de filtro.

NumberInRangeAdvancedFilter

Objeto

Filtro Avançado NumberInRange.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberInRange	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[] (double)	O conjunto de valores de filtro.

NumberLessThanAdvancedFilter

Objeto

Filtro Avançado NumberLessThan.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberLessThan	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number (double)	O valor do filtro.

NumberLessThanOrEqualsAdvancedFilter

Objeto

Filtro Avançado NumberLessThanOrEquals.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberLessThanOrEquals	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number (double)	O valor do filtro.

NumberNotInAdvancedFilter

Objeto

Filtro Avançado NumberNotIn.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberNotIn	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[] (double)	O conjunto de valores de filtro.

NumberNotInRangeAdvancedFilter

Objeto

Filtro Avançado NumberNotInRange.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: NumberNotInRange	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[] (double)	O conjunto de valores de filtro.

RetryPolicy

Objeto

Informações sobre a política de repetição de uma assinatura de evento.

Nome	Tipo	Valor padrão	Description
eventTimeToLiveInMinutes	integer (int32)	1440	Vida útil (em minutos) para eventos.
maxDeliveryAttempts	integer (int32)	30	Número máximo de tentativas de repetição de entrega para eventos.

ServiceBusQueueEventSubscriptionDestination

Objeto

Informações sobre o destino do barramento de serviço para uma assinatura de evento.

Nome	Tipo	Description
endpointType	string: ServiceBusQueue	Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string (arm-id)	A ID de Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento.

ServiceBusTopicEventSubscriptionDestination

Objeto

Informações sobre o destino do tópico do barramento de serviço para uma assinatura de evento.

Nome	Tipo	Description
endpointType	string: ServiceBusTopic	Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string (arm-id)	A ID de Recurso do Azure que representa o ponto de extremidade do destino do Tópico do Barramento de Serviço de uma assinatura de evento.

StaticDeliveryAttributeMapping

Objeto

Detalhes do mapeamento de atributo de entrega estática.

Nome	Tipo	Valor padrão	Description
name	string		Nome do atributo ou cabeçalho de entrega.
properties.isSecret	boolean	False	Sinalizador booliano para saber se o atributo contém informações confidenciais.
properties.value	string		Valor do atributo de entrega.
type	string: Static		Tipo do atributo de entrega ou nome do cabeçalho.

StorageBlobDeadLetterDestination

Objeto

Informações sobre o destino de mensagens mortas baseadas em blob de armazenamento.

Nome	Tipo	Description
endpointType	string: StorageBlob	Tipo do ponto de extremidade para o destino da letra morta
properties.blobContainerName	string	O nome do contêiner de blob de armazenamento que é o destino dos eventos de deadletter
properties.resourceId	string (arm-id)	A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos de deadletter

StorageQueueEventSubscriptionDestination

Objeto

Informações sobre o destino da fila de armazenamento para uma assinatura de evento.

Nome	Tipo	Description
endpointType	string: StorageQueue	Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.queueMessageTimeToLiveInSeconds	integer (int64)	Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção de usar -1 para indicar que a vida útil da mensagem é Infinita.
properties.queueName	string	O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento.
properties.resourceId	string (arm-id)	A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento.

StringBeginsWithAdvancedFilter

Objeto

StringBeginsWith Advanced Filter.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringBeginsWith	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringContainsAdvancedFilter

Objeto

Filtro Avançado StringContains.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringContains	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringEndsWithAdvancedFilter

Objeto

StringEndsWith Advanced Filter.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringEndsWith	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringInAdvancedFilter

Objeto

Filtro Avançado StringIn.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringIn	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringNotBeginsWithAdvancedFilter

Objeto

StringNotBeginsWith Advanced Filter.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringNotBeginsWith	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringNotContainsAdvancedFilter

Objeto

Filtro Avançado StringNotContains.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringNotContains	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringNotEndsWithAdvancedFilter

Objeto

StringNotEndsWith Advanced Filter.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringNotEndsWith	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringNotInAdvancedFilter

Objeto

Filtro Avançado StringNotIn.

Nome	Tipo	Description
key	string	O campo/propriedade no evento com base no qual você deseja filtrar.
operatorType	string: StringNotIn	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TlsVersion

Enumeração

Versão mínima do TLS do publicador com permissão para publicar neste domínio

Valor	Description
1.0
1.1
1.2

WebHookEventSubscriptionDestination

Objeto

Informações sobre o destino do webhook para uma assinatura de evento.

Nome	Tipo	Valor padrão	Description
endpointType	string: WebHook		Tipo do ponto de extremidade para o destino da assinatura do evento.
properties.azureActiveDirectoryApplicationIdOrUri	string		A ID ou o URI do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega.
properties.azureActiveDirectoryTenantId	string		A ID do Locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Detalhes do atributo de entrega.
properties.endpointBaseUrl	string		A URL base que representa o ponto de extremidade do destino de uma assinatura de evento.
properties.endpointUrl	string		A URL que representa o ponto de extremidade do destino de uma assinatura de evento.
properties.maxEventsPerBatch	integer (int32)	1	Número máximo de eventos por lote.
properties.minimumTlsVersionAllowed	TlsVersion		Versão mínima do TLS que deve ser suportada pelo ponto de extremidade do webhook
properties.preferredBatchSizeInKilobytes	integer (int32)	64	Tamanho de lote preferencial em Kilobytes.