System Topic Event Subscriptions - Create Or Update

Serviço:

Event Grid

Versão da API:

2022-06-15

Criar ou atualizar uma subscrição de evento para um tópico de sistema.
Cria ou atualiza de forma assíncrona uma subscrição de evento com os parâmetros especificados. As subscrições de eventos existentes serão atualizadas com 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 do URI

Name	Em	Necessário	Tipo	Description
eventSubscriptionName	path	True	string	Nome da subscrição do evento a criar. Os nomes das subscrições de eventos têm de ter entre 3 e 100 carateres de comprimento e utilizar apenas letras alfanuméricas.
resourceGroupName	path	True	string	O nome do grupo de recursos na subscrição do utilizador.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
systemTopicName	path	True	string	Nome do tópico do sistema.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Corpo do Pedido

Name	Tipo	Description
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	O destino da carta não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do mesmo é enviado para o destino da carta não entregue. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/sem letras.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity	O destino da letra não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do respetivo destino é enviado para o destino da letra não entregue. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/letra não entregue.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity	Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
properties.destination	EventSubscriptionDestination: WebHookEventSubscriptionDestination EventHubEventSubscriptionDestination StorageQueueEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination AzureFunctionEventSubscriptionDestination	Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
properties.eventDeliverySchema	EventDeliverySchema	O esquema de entrega de eventos para a subscrição do evento.
properties.expirationTimeUtc	string	Hora de expiração da subscrição do evento.
properties.filter	EventSubscriptionFilter	Informações sobre o filtro para a subscrição de eventos.
properties.labels	string[]	Lista de etiquetas definidas pelo utilizador.
properties.retryPolicy	RetryPolicy	A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de duração para eventos.

Respostas

Name	Tipo	Description
201 Created	EventSubscription	Criado
Other Status Codes		Respostas de Erro: *** 400 Pedido Incorreto. Erro de Servidor Interno 500.

Exemplos

SystemTopicEventSubscriptions_CreateOrUpdate

Pedido de amostra

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

Resposta da amostra

Código de estado:

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"
}

Definições

Name	Description
AzureFunctionEventSubscriptionDestination	Informações sobre o destino da função do Azure para uma subscrição 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 subscrição de evento com identidade de recurso.
DynamicDeliveryAttributeMapping	Detalhes do mapeamento de atributos de entrega dinâmica.
EventDeliverySchema	O esquema de entrega de eventos para a subscrição do evento.
EventHubEventSubscriptionDestination	Informações sobre o destino do hub de eventos para uma subscrição de eventos.
EventSubscription	Subscrição de Eventos
EventSubscriptionFilter	Filtre pela Subscrição de Eventos.
EventSubscriptionIdentity	As informações de identidade com a subscrição do evento.
EventSubscriptionIdentityType	O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.
EventSubscriptionProvisioningState	Estado de aprovisionamento da subscrição do evento.
HybridConnectionEventSubscriptionDestination	Informações sobre o destino HybridConnection de uma subscrição de evento.
IsNotNullAdvancedFilter	IsNotNull Advanced Filter.
IsNullOrUndefinedAdvancedFilter	Filtro Avançado IsNullOrUndefined.
NumberGreaterThanAdvancedFilter	NumberGreaterThan Advanced Filter.
NumberGreaterThanOrEqualsAdvancedFilter	NumberGreaterThanOrEquals Filtro Avançado.
NumberInAdvancedFilter	NumberIn Advanced Filter.
NumberInRangeAdvancedFilter	NumberInRange Advanced Filter.
NumberLessThanAdvancedFilter	NumberLessThan Advanced Filter.
NumberLessThanOrEqualsAdvancedFilter	NumberLessThanOrEquals Filtro Avançado.
NumberNotInAdvancedFilter	Filtro Avançado NumberNotIn.
NumberNotInRangeAdvancedFilter	NumberNotInRange Advanced Filter.
RetryPolicy	Informações sobre a política de repetição de uma subscrição de evento.
ServiceBusQueueEventSubscriptionDestination	Informações sobre o destino do service bus para uma subscrição de evento.
ServiceBusTopicEventSubscriptionDestination	Informações sobre o destino do tópico do service bus para uma subscrição de evento.
StaticDeliveryAttributeMapping	Detalhes do mapeamento do atributo de entrega estática.
StorageBlobDeadLetterDestination	Informações sobre o destino de mensagens não entregues baseadas em blobs de armazenamento.
StorageQueueEventSubscriptionDestination	Informações sobre o destino da fila de armazenamento para uma subscrição de evento.
StringBeginsWithAdvancedFilter	StringBeginsWith Advanced Filter.
StringContainsAdvancedFilter	StringContains Filtro Avançado.
StringEndsWithAdvancedFilter	StringEndsWith Advanced Filter.
StringInAdvancedFilter	StringIn Advanced Filter.
StringNotBeginsWithAdvancedFilter	StringNotBeginsWith Advanced Filter.
StringNotContainsAdvancedFilter	StringNotContains Filtro Avançado.
StringNotEndsWithAdvancedFilter	StringNotEndsWith Advanced Filter.
StringNotInAdvancedFilter	Filtro Avançado StringNotIn.
systemData	Metadados relativos à criação e última modificação do recurso.
WebHookEventSubscriptionDestination	Informações sobre o destino do webhook para uma subscrição de evento.

AzureFunctionEventSubscriptionDestination

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

Name	Tipo	Default value	Description
endpointType	string: AzureFunction		Tipo de ponto final para o destino da subscrição de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Detalhes do atributo de entrega.
properties.maxEventsPerBatch	integer	1	Número máximo de eventos por lote.
properties.preferredBatchSizeInKilobytes	integer	64	Tamanho preferencial do lote em Kilobytes.
properties.resourceId	string		O ID de Recurso do Azure que representa o ponto final do destino da Função do Azure de uma subscrição de evento.

BoolEqualsAdvancedFilter

Filtro Avançado BoolEquals.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: BoolEquals	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	boolean	O valor do filtro booleano.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DeadLetterWithResourceIdentity

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

Name	Tipo	Description
deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
identity	EventSubscriptionIdentity	A identidade a utilizar em eventos de mensagens não entregues.

DeliveryWithResourceIdentity

Informações sobre a entrega de uma subscrição de evento com identidade de recurso.

Name	Tipo	Description
destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination	Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
identity	EventSubscriptionIdentity	A identidade a utilizar ao entregar eventos.

DynamicDeliveryAttributeMapping

Detalhes do mapeamento de atributos de entrega dinâmica.

Name	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 de atributo de entrega ou nome de cabeçalho.

EventDeliverySchema

O esquema de entrega de eventos para a subscrição do evento.

Name	Tipo	Description
CloudEventSchemaV1_0	string
CustomInputSchema	string
EventGridSchema	string

EventHubEventSubscriptionDestination

Informações sobre o destino do hub de eventos para uma subscrição de eventos.

Name	Tipo	Description
endpointType	string: EventHub	Tipo de ponto final para o destino da subscrição de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string	O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento.

EventSubscription

Subscrição de Eventos

Name	Tipo	Default value	Description
id	string		Identificador completamente qualificado do recurso.
name	string		Nome do recurso.
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination		O destino da carta não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do mesmo é enviado para o destino da carta não entregue. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity		O destino da carta não entregue da subscrição do evento. Qualquer evento que não possa ser entregue no destino do mesmo é enviado para o destino da carta não entregue. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity		Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a configuração da identidade gerida no recurso principal (nomeadamente, tópico ou domínio) para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
properties.destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination		Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. Utiliza a identidade do Azure Event Grid para adquirir os tokens de autenticação que estão a ser utilizados durante a entrega/mensagens não entregues.
properties.eventDeliverySchema	EventDeliverySchema	EventGridSchema	O esquema de entrega de eventos para a subscrição do evento.
properties.expirationTimeUtc	string		Hora de expiração da subscrição do evento.
properties.filter	EventSubscriptionFilter		Informações sobre o filtro para a subscrição de eventos.
properties.labels	string[]		Lista de etiquetas definidas pelo utilizador.
properties.provisioningState	EventSubscriptionProvisioningState		Estado de aprovisionamento da subscrição do evento.
properties.retryPolicy	RetryPolicy		A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de duração para eventos.
properties.topic	string		Nome do tópico da subscrição do evento.
systemData	systemData		Os metadados do sistema relacionados com o recurso da Subscrição de Eventos.
type	string		Tipo do recurso.

EventSubscriptionFilter

Filtre pela Subscrição de Eventos.

Name	Tipo	Default value	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 utilizados para filtrar subscrições de eventos.
enableAdvancedFilteringOnArrays	boolean		Permite que os filtros avançados sejam avaliados relativamente a uma matriz de valores em vez de esperar um valor singular.
includedEventTypes	string[]		Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se pretender subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo.
isSubjectCaseSensitive	boolean	False	Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro devem ser comparadas de forma sensível a maiúsculas e minúsculas.
subjectBeginsWith	string		Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso. O formato depende do publicador dos eventos. Os carateres universais não são suportados neste caminho.
subjectEndsWith	string		Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso. Os carateres universais não são suportados neste caminho.

EventSubscriptionIdentity

As informações de identidade com a subscrição do evento.

Name	Tipo	Description
type	EventSubscriptionIdentityType	O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.
userAssignedIdentity	string	A identidade de utilizador associada ao recurso.

EventSubscriptionIdentityType

O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.

Name	Tipo	Description
SystemAssigned	string
UserAssigned	string

EventSubscriptionProvisioningState

Estado de aprovisionamento da subscrição do evento.

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

HybridConnectionEventSubscriptionDestination

Informações sobre o destino HybridConnection de uma subscrição de evento.

Name	Tipo	Description
endpointType	string: HybridConnection	Tipo de ponto final para o destino da subscrição de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string	O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento.

IsNotNullAdvancedFilter

IsNotNull Advanced Filter.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: IsNotNull	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

IsNullOrUndefinedAdvancedFilter

Filtro Avançado IsNullOrUndefined.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: IsNullOrUndefined	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.

NumberGreaterThanAdvancedFilter

NumberGreaterThan Advanced Filter.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberGreaterThan	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number	O valor do filtro.

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals Filtro Avançado.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberGreaterThanOrEquals	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number	O valor do filtro.

NumberInAdvancedFilter

NumberIn Advanced Filter.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberIn	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[]	O conjunto de valores de filtro.

NumberInRangeAdvancedFilter

NumberInRange Advanced Filter.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberInRange	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[]	O conjunto de valores de filtro.

NumberLessThanAdvancedFilter

NumberLessThan Advanced Filter.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberLessThan	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number	O valor do filtro.

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals Filtro Avançado.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberLessThanOrEquals	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
value	number	O valor do filtro.

NumberNotInAdvancedFilter

Filtro Avançado NumberNotIn.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberNotIn	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[]	O conjunto de valores de filtro.

NumberNotInRangeAdvancedFilter

NumberNotInRange Advanced Filter.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: NumberNotInRange	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	number[]	O conjunto de valores de filtro.

RetryPolicy

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

Name	Tipo	Default value	Description
eventTimeToLiveInMinutes	integer	1440	Time To Live (em minutos) para eventos.
maxDeliveryAttempts	integer	30	Número máximo de tentativas de repetição de entrega para eventos.

ServiceBusQueueEventSubscriptionDestination

Informações sobre o destino do service bus para uma subscrição de evento.

Name	Tipo	Description
endpointType	string: ServiceBusQueue	Tipo de ponto final para o destino da subscrição de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string	O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento.

ServiceBusTopicEventSubscriptionDestination

Informações sobre o destino do tópico do service bus para uma subscrição de evento.

Name	Tipo	Description
endpointType	string: ServiceBusTopic	Tipo de ponto final para o destino da subscrição de eventos.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	Detalhes do atributo de entrega.
properties.resourceId	string	O ID de Recurso do Azure que representa o ponto final do destino do Tópico do Service Bus de uma subscrição de evento.

StaticDeliveryAttributeMapping

Detalhes do mapeamento do atributo de entrega estática.

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

StorageBlobDeadLetterDestination

Informações sobre o destino de mensagens não entregues baseadas em blobs de armazenamento.

Name	Tipo	Description
endpointType	string: StorageBlob	Tipo de ponto final para o destino da letra não entregue
properties.blobContainerName	string	O nome do contentor de blobs de Armazenamento que é o destino dos eventos deadletter
properties.resourceId	string	O ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter

StorageQueueEventSubscriptionDestination

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

Name	Tipo	Description
endpointType	string: StorageQueue	Tipo de ponto final para o destino da subscrição de eventos.
properties.queueMessageTimeToLiveInSeconds	integer	Tempo de vida da mensagem da fila de armazenamento em segundos.
properties.queueName	string	O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento.
properties.resourceId	string	O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento.

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.

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

StringContainsAdvancedFilter

StringContains Filtro Avançado.

Name	Tipo	Description
key	string	O campo/propriedade no evento com base no qual pretende filtrar.
operatorType	string: StringContains	O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros.
values	string[]	O conjunto de valores de filtro.

StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.

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

StringInAdvancedFilter

StringIn Advanced Filter.

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

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.

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

StringNotContainsAdvancedFilter

StringNotContains Filtro Avançado.

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

StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.

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

StringNotInAdvancedFilter

Filtro Avançado StringNotIn.

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

systemData

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

Name	Tipo	Description
createdAt	string	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	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.

WebHookEventSubscriptionDestination

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

Name	Tipo	Default value	Description
endpointType	string: WebHook		Tipo de ponto final para o destino da subscrição de eventos.
properties.azureActiveDirectoryApplicationIdOrUri	string		O ID ou URI da Aplicação do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nos pedidos de entrega.
properties.azureActiveDirectoryTenantId	string		O ID de Inquilino do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nos pedidos de entrega.
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		Detalhes do atributo de entrega.
properties.endpointBaseUrl	string		O URL base que representa o ponto final do destino de uma subscrição de evento.
properties.endpointUrl	string		O URL que representa o ponto final do destino de uma subscrição de evento.
properties.maxEventsPerBatch	integer	1	Número máximo de eventos por lote.
properties.preferredBatchSizeInKilobytes	integer	64	Tamanho preferencial do lote em Kilobytes.